@xyo-network/node-model 5.3.25 → 5.3.27

package/README.md

@@ -1,23 +1,3738 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/node-model
 
-[![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__node-model)
+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
+
+      ### node
+
+        ### packages
+
+          ### model
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="IsAttachableNodeInstanceFactory"></a>IsAttachableNodeInstanceFactory
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- `IsObjectFactory`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`AttachableNodeInstance`](#../interfaces/AttachableNodeInstance) = [`AttachableNodeInstance`](#../interfaces/AttachableNodeInstance)
+
+## Constructors
+
+### Constructor
+
+```ts
+new IsAttachableNodeInstanceFactory<T>(): IsAttachableNodeInstanceFactory<T>;
+```
+
+### Returns
+
+`IsAttachableNodeInstanceFactory`\<`T`\>
+
+### Inherited from
+
+```ts
+IsObjectFactory<T>.constructor
+```
+
+              ### interfaces
+
+                ### <a id="AttachableNodeInstance"></a>AttachableNodeInstance
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- [`NodeModule`](#NodeModule)\<`TParams`, `TEventData`\>.`AttachableModuleInstance`\<`TParams`, `TEventData`\>.[`NodeInstance`](#NodeInstance)\<`TParams`, `TEventData`\>
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`NodeParams`](#NodeParams) = [`NodeParams`](#NodeParams)
+
+### TEventData
+
+`TEventData` *extends* [`NodeModuleEventData`](#NodeModuleEventData) = [`NodeModuleEventData`](#NodeModuleEventData)
+
+## Properties
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`address`](NodeModule.md#address)
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`config`](NodeModule.md#config)
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`id`](NodeInstance.md#id)
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`modName`](NodeInstance.md#modname)
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`params`](NodeModule.md#params)
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`previousHash`](NodeModule.md#previoushash)
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`queries`](NodeInstance.md#queries)
+
+***
+
+### query
+
+```ts
+query: <T, TConf>(query, payloads?, queryConfig?) => Promisable<ModuleQueryResult>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`query`](NodeModule.md#query)
+
+***
+
+### queryable
+
+```ts
+queryable: <T, TConf>(query, payloads?, queryConfig?) => Promisable<boolean>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`boolean`\>
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`queryable`](NodeModule.md#queryable)
+
+***
+
+### manifest
+
+```ts
+manifest: (maxDepth?, ignoreAddresses?) => Promisable<ModuleManifestPayload>;
+```
+
+### Parameters
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleManifestPayload`\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`manifest`](NodeInstance.md#manifest)
+
+***
+
+### manifestQuery
+
+```ts
+manifestQuery: (account, maxDepth?, ignoreAddresses?) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`manifestQuery`](NodeInstance.md#manifestquery)
+
+***
+
+### moduleAddress
+
+```ts
+moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
+```
+
+### Returns
+
+`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`moduleAddress`](NodeInstance.md#moduleaddress)
+
+***
+
+### state
+
+```ts
+state: () => Promisable<Payload[]>;
+```
+
+### Returns
+
+`Promisable`\<`Payload`[]\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`state`](NodeInstance.md#state)
+
+***
+
+### stateQuery
+
+```ts
+stateQuery: (account) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`stateQuery`](NodeInstance.md#statequery)
+
+***
+
+### account?
+
+```ts
+optional account?: AccountInstance;
+```
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`account`](NodeInstance.md#account)
+
+***
+
+### addParent
+
+```ts
+addParent: (mod) => void;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`addParent`](NodeInstance.md#addparent)
+
+***
+
+### addressCache?
+
+```ts
+optional addressCache?: (direction, includePrivate) => AddressToWeakInstanceCache | undefined;
+```
+
+### Parameters
+
+#### direction
+
+`Direction`
+
+#### includePrivate
+
+`boolean`
+
+### Returns
+
+`AddressToWeakInstanceCache` \| `undefined`
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`addressCache`](NodeInstance.md#addresscache)
+
+***
+
+### parents
+
+```ts
+parents: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`parents`](NodeInstance.md#parents)
+
+***
+
+### privateChildren
+
+```ts
+privateChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`privateChildren`](NodeInstance.md#privatechildren)
+
+***
+
+### publicChildren
+
+```ts
+publicChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`publicChildren`](NodeInstance.md#publicchildren)
+
+***
+
+### removeParent
+
+```ts
+removeParent: (address) => void;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`removeParent`](NodeInstance.md#removeparent)
+
+***
+
+### siblings
+
+```ts
+siblings: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`siblings`](NodeInstance.md#siblings)
+
+***
+
+### pipeline?
+
+```ts
+readonly optional pipeline?: "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
+```
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`pipeline`](NodeInstance.md#pipeline)
+
+***
+
+### status
+
+```ts
+readonly status: ModuleStatus | null;
+```
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`status`](NodeInstance.md#status)
+
+***
+
+### priority
+
+```ts
+priority: ObjectResolverPriority;
+```
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`priority`](NodeInstance.md#priority)
+
+***
+
+### downResolver
+
+```ts
+readonly downResolver: ModuleResolverInstance;
+```
+
+### Inherited from
+
+```ts
+AttachableModuleInstance.downResolver
+```
+
+***
+
+### privateResolver
+
+```ts
+readonly privateResolver: ModuleResolverInstance;
+```
+
+### Inherited from
+
+```ts
+AttachableModuleInstance.privateResolver
+```
+
+***
+
+### upResolver
+
+```ts
+readonly upResolver: ModuleResolverInstance;
+```
+
+### Inherited from
+
+```ts
+AttachableModuleInstance.upResolver
+```
+
+***
+
+### attach
+
+```ts
+attach: (id, external?) => Promise<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### external?
+
+`boolean`
+
+### Returns
+
+`Promise`\<`BrandedAddress` \| `undefined`\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`attach`](NodeInstance.md#attach)
+
+***
+
+### attachQuery
+
+```ts
+attachQuery: (id, external?, account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### external?
+
+`boolean`
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`attachQuery`](NodeInstance.md#attachquery)
+
+***
+
+### attached
+
+```ts
+attached: () => Promise<BrandedAddress[]>;
+```
+
+### Returns
+
+`Promise`\<`BrandedAddress`[]\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`attached`](NodeInstance.md#attached)
+
+***
+
+### attachedQuery
+
+```ts
+attachedQuery: (account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`attachedQuery`](NodeInstance.md#attachedquery)
+
+***
+
+### certify
+
+```ts
+certify: (id) => Promise<ChildCertificationFields | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+### Returns
+
+`Promise`\<[`ChildCertificationFields`](#ChildCertificationFields) \| `undefined`\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`certify`](NodeInstance.md#certify)
+
+***
+
+### certifyQuery
+
+```ts
+certifyQuery: (id, account?) => Promise<ModuleQueryResult<ChildCertification>>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<[`ChildCertification`](#../type-aliases/ChildCertification)\>\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`certifyQuery`](NodeInstance.md#certifyquery)
+
+***
+
+### detach
+
+```ts
+detach: (id) => Promise<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+### Returns
+
+`Promise`\<`BrandedAddress` \| `undefined`\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`detach`](NodeInstance.md#detach)
+
+***
+
+### detachQuery
+
+```ts
+detachQuery: (id, account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`detachQuery`](NodeInstance.md#detachquery)
+
+***
+
+### registered
+
+```ts
+registered: () => Promise<BrandedAddress[]>;
+```
+
+### Returns
+
+`Promise`\<`BrandedAddress`[]\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`registered`](NodeInstance.md#registered)
+
+***
+
+### registeredQuery
+
+```ts
+registeredQuery: (account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`registeredQuery`](NodeInstance.md#registeredquery)
+
+***
+
+### register?
+
+```ts
+optional register?: (mod) => Promise<void>;
+```
+
+### Parameters
+
+#### mod
+
+`AttachableModuleInstance`
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`register`](NodeInstance.md#register)
+
+***
+
+### registeredModules?
+
+```ts
+optional registeredModules?: () => AttachableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];
+```
+
+### Returns
+
+`AttachableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`registeredModules`](NodeInstance.md#registeredmodules)
+
+***
+
+### unregister?
+
+```ts
+optional unregister?: (mod) => Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
+
+### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`unregister`](NodeInstance.md#unregister)
+
+## Methods
+
+### resolve()
+
+### Call Signature
+
+```ts
+resolve<T>(all, options?): Promisable<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### all
+
+`"*"`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promisable`\<`T`[]\>
+
+#### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`resolve`](NodeInstance.md#resolve)
+
+### Call Signature
+
+```ts
+resolve<T>(id, options?): Promisable<T | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id
+
+`ModuleIdentifier`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promisable`\<`T` \| `undefined`\>
+
+#### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`resolve`](NodeInstance.md#resolve)
+
+### Call Signature
+
+```ts
+resolve<T>(id?, options?): Promisable<T | T[] | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id?
+
+`ModuleIdentifier`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promisable`\<`T` \| `T`[] \| `undefined`\>
+
+#### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`resolve`](NodeInstance.md#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?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`resolvePrivate`](NodeInstance.md#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?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+#### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`resolvePrivate`](NodeInstance.md#resolveprivate)
+
+### Call Signature
+
+```ts
+resolvePrivate<T>(id, options?): Promise<T | T[] | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id
+
+`ModuleIdentifier`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` \| `T`[] \| `undefined`\>
+
+#### Inherited from
+
+[`NodeInstance`](#NodeInstance).[`resolvePrivate`](NodeInstance.md#resolveprivate)
+
+                ### <a id="ChildCertificationFields"></a>ChildCertificationFields
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Properties
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+***
+
+### expiration
+
+```ts
+expiration: number;
+```
+
+                ### <a id="ModuleAttachedEventData"></a>ModuleAttachedEventData
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`NodeModuleEventData`](#NodeModuleEventData)
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### moduleAttached
+
+```ts
+moduleAttached: object;
+```
+
+### mod
+
+```ts
+mod: QueryableModule;
+```
+
+                ### <a id="ModuleDetachedEventData"></a>ModuleDetachedEventData
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`NodeModuleEventData`](#NodeModuleEventData)
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### moduleDetached
+
+```ts
+moduleDetached: object;
+```
+
+### mod
+
+```ts
+mod: QueryableModule;
+```
+
+                ### <a id="ModuleRegisteredEventData"></a>ModuleRegisteredEventData
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`NodeModuleEventData`](#NodeModuleEventData)
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### moduleRegistered
+
+```ts
+moduleRegistered: object;
+```
+
+### mod
+
+```ts
+mod: QueryableModule;
+```
+
+                ### <a id="ModuleUnregisteredEventData"></a>ModuleUnregisteredEventData
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`NodeModuleEventData`](#NodeModuleEventData)
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### moduleUnregistered
+
+```ts
+moduleUnregistered: object;
+```
+
+### mod
+
+```ts
+mod: QueryableModule;
+```
+
+                ### <a id="NodeInstance"></a>NodeInstance
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- [`NodeModule`](#NodeModule)\<`TParams`, `TEventData`\>.[`NodeQueryFunctions`](#NodeQueryFunctions).[`NodeRegistrationFunctions`](#NodeRegistrationFunctions).`ModuleInstance`\<`TParams`, `TEventData`\>
+
+## Extended by
+
+- [`AttachableNodeInstance`](#AttachableNodeInstance)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`NodeParams`](#NodeParams) = [`NodeParams`](#NodeParams)
+
+### TEventData
+
+`TEventData` *extends* [`NodeModuleEventData`](#NodeModuleEventData) = [`NodeModuleEventData`](#NodeModuleEventData)
+
+## Properties
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`address`](NodeModule.md#address)
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`config`](NodeModule.md#config)
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`id`](NodeModule.md#id)
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`modName`](NodeModule.md#modname)
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`params`](NodeModule.md#params)
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`previousHash`](NodeModule.md#previoushash)
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`queries`](NodeModule.md#queries)
+
+***
+
+### query
+
+```ts
+query: <T, TConf>(query, payloads?, queryConfig?) => Promisable<ModuleQueryResult>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`query`](NodeModule.md#query)
+
+***
+
+### queryable
+
+```ts
+queryable: <T, TConf>(query, payloads?, queryConfig?) => Promisable<boolean>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`boolean`\>
+
+### Inherited from
+
+[`NodeModule`](#NodeModule).[`queryable`](NodeModule.md#queryable)
+
+***
+
+### manifest
+
+```ts
+manifest: (maxDepth?, ignoreAddresses?) => Promisable<ModuleManifestPayload>;
+```
+
+### Parameters
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleManifestPayload`\>
+
+### Inherited from
+
+```ts
+ModuleInstance.manifest
+```
+
+***
+
+### manifestQuery
+
+```ts
+manifestQuery: (account, maxDepth?, ignoreAddresses?) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
+
+### Inherited from
+
+```ts
+ModuleInstance.manifestQuery
+```
+
+***
+
+### moduleAddress
+
+```ts
+moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
+```
+
+### Returns
+
+`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.moduleAddress
+```
+
+***
+
+### state
+
+```ts
+state: () => Promisable<Payload[]>;
+```
+
+### Returns
+
+`Promisable`\<`Payload`[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.state
+```
+
+***
+
+### stateQuery
+
+```ts
+stateQuery: (account) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+```ts
+ModuleInstance.stateQuery
+```
+
+***
+
+### account?
+
+```ts
+optional account?: AccountInstance;
+```
+
+### Inherited from
+
+```ts
+ModuleInstance.account
+```
+
+***
+
+### addParent
+
+```ts
+addParent: (mod) => void;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+```ts
+ModuleInstance.addParent
+```
+
+***
+
+### addressCache?
+
+```ts
+optional addressCache?: (direction, includePrivate) => AddressToWeakInstanceCache | undefined;
+```
+
+### Parameters
+
+#### direction
+
+`Direction`
+
+#### includePrivate
+
+`boolean`
+
+### Returns
+
+`AddressToWeakInstanceCache` \| `undefined`
+
+### Inherited from
+
+```ts
+ModuleInstance.addressCache
+```
+
+***
+
+### parents
+
+```ts
+parents: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.parents
+```
+
+***
+
+### privateChildren
+
+```ts
+privateChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.privateChildren
+```
+
+***
+
+### publicChildren
+
+```ts
+publicChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.publicChildren
+```
+
+***
+
+### removeParent
+
+```ts
+removeParent: (address) => void;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+```ts
+ModuleInstance.removeParent
+```
+
+***
+
+### siblings
+
+```ts
+siblings: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+```ts
+ModuleInstance.siblings
+```
+
+***
+
+### pipeline?
+
+```ts
+readonly optional pipeline?: "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
+```
+
+### Inherited from
+
+```ts
+ModuleInstance.pipeline
+```
+
+***
+
+### status
+
+```ts
+readonly status: ModuleStatus | null;
+```
+
+### Inherited from
+
+```ts
+ModuleInstance.status
+```
+
+***
+
+### priority
+
+```ts
+priority: ObjectResolverPriority;
+```
+
+### Inherited from
+
+```ts
+ModuleInstance.priority
+```
+
+***
+
+### attach
+
+```ts
+attach: (id, external?) => Promise<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### external?
+
+`boolean`
+
+### Returns
+
+`Promise`\<`BrandedAddress` \| `undefined`\>
+
+### Inherited from
+
+[`NodeQueryFunctions`](#NodeQueryFunctions).[`attach`](NodeQueryFunctions.md#attach)
+
+***
+
+### attachQuery
+
+```ts
+attachQuery: (id, external?, account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### external?
+
+`boolean`
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+### Inherited from
+
+[`NodeQueryFunctions`](#NodeQueryFunctions).[`attachQuery`](NodeQueryFunctions.md#attachquery)
+
+***
+
+### attached
+
+```ts
+attached: () => Promise<BrandedAddress[]>;
+```
+
+### Returns
+
+`Promise`\<`BrandedAddress`[]\>
+
+### Inherited from
+
+[`NodeQueryFunctions`](#NodeQueryFunctions).[`attached`](NodeQueryFunctions.md#attached)
+
+***
+
+### attachedQuery
+
+```ts
+attachedQuery: (account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+### Inherited from
+
+[`NodeQueryFunctions`](#NodeQueryFunctions).[`attachedQuery`](NodeQueryFunctions.md#attachedquery)
+
+***
+
+### certify
+
+```ts
+certify: (id) => Promise<ChildCertificationFields | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+### Returns
+
+`Promise`\<[`ChildCertificationFields`](#ChildCertificationFields) \| `undefined`\>
+
+### Inherited from
+
+[`NodeQueryFunctions`](#NodeQueryFunctions).[`certify`](NodeQueryFunctions.md#certify)
+
+***
+
+### certifyQuery
+
+```ts
+certifyQuery: (id, account?) => Promise<ModuleQueryResult<ChildCertification>>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<[`ChildCertification`](#../type-aliases/ChildCertification)\>\>
+
+### Inherited from
+
+[`NodeQueryFunctions`](#NodeQueryFunctions).[`certifyQuery`](NodeQueryFunctions.md#certifyquery)
+
+***
+
+### detach
+
+```ts
+detach: (id) => Promise<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+### Returns
+
+`Promise`\<`BrandedAddress` \| `undefined`\>
+
+### Inherited from
+
+[`NodeQueryFunctions`](#NodeQueryFunctions).[`detach`](NodeQueryFunctions.md#detach)
+
+***
+
+### detachQuery
+
+```ts
+detachQuery: (id, account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+### Inherited from
+
+[`NodeQueryFunctions`](#NodeQueryFunctions).[`detachQuery`](NodeQueryFunctions.md#detachquery)
+
+***
+
+### registered
+
+```ts
+registered: () => Promise<BrandedAddress[]>;
+```
+
+### Returns
+
+`Promise`\<`BrandedAddress`[]\>
+
+### Inherited from
+
+[`NodeQueryFunctions`](#NodeQueryFunctions).[`registered`](NodeQueryFunctions.md#registered)
+
+***
+
+### registeredQuery
+
+```ts
+registeredQuery: (account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+### Inherited from
+
+[`NodeQueryFunctions`](#NodeQueryFunctions).[`registeredQuery`](NodeQueryFunctions.md#registeredquery)
+
+***
+
+### register?
+
+```ts
+optional register?: (mod) => Promise<void>;
+```
+
+### Parameters
+
+#### mod
+
+`AttachableModuleInstance`
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Inherited from
+
+[`NodeRegistrationFunctions`](#NodeRegistrationFunctions).[`register`](NodeRegistrationFunctions.md#register)
+
+***
+
+### registeredModules?
+
+```ts
+optional registeredModules?: () => AttachableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];
+```
+
+### Returns
+
+`AttachableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]
+
+### Inherited from
+
+[`NodeRegistrationFunctions`](#NodeRegistrationFunctions).[`registeredModules`](NodeRegistrationFunctions.md#registeredmodules)
+
+***
+
+### unregister?
+
+```ts
+optional unregister?: (mod) => Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
+
+### Inherited from
+
+[`NodeRegistrationFunctions`](#NodeRegistrationFunctions).[`unregister`](NodeRegistrationFunctions.md#unregister)
+
+## Methods
+
+### resolve()
+
+### Call Signature
+
+```ts
+resolve<T>(all, options?): Promisable<T[]>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### all
+
+`"*"`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promisable`\<`T`[]\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.resolve
+```
+
+### Call Signature
+
+```ts
+resolve<T>(id, options?): Promisable<T | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id
+
+`ModuleIdentifier`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promisable`\<`T` \| `undefined`\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.resolve
+```
+
+### Call Signature
+
+```ts
+resolve<T>(id?, options?): Promisable<T | T[] | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id?
+
+`ModuleIdentifier`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promisable`\<`T` \| `T`[] \| `undefined`\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.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?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T`[]\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.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?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` \| `undefined`\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.resolvePrivate
+```
+
+### Call Signature
+
+```ts
+resolvePrivate<T>(id, options?): Promise<T | T[] | undefined>;
+```
+
+#### Type Parameters
+
+##### T
+
+`T` *extends* `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\> = `ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>
+
+#### Parameters
+
+##### id
+
+`ModuleIdentifier`
+
+##### options?
+
+`ObjectFilterOptions`\<`T`\>
+
+#### Returns
+
+`Promise`\<`T` \| `T`[] \| `undefined`\>
+
+#### Inherited from
+
+```ts
+ModuleInstance.resolvePrivate
+```
+
+                ### <a id="NodeInstanceParams"></a>NodeInstanceParams
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- `ModuleInstanceParams`\<`TConfig`\>
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* `AnyConfigSchema`\<[`NodeConfig`](#../type-aliases/NodeConfig)\> = `AnyConfigSchema`\<[`NodeConfig`](#../type-aliases/NodeConfig)\>
+
+## Properties
+
+### account?
+
+```ts
+optional account?: AccountInstance | "random";
+```
+
+### Inherited from
+
+```ts
+ModuleInstanceParams.account
+```
+
+***
+
+### addToResolvers?
+
+```ts
+optional addToResolvers?: boolean;
+```
+
+### Inherited from
+
+```ts
+ModuleInstanceParams.addToResolvers
+```
+
+***
+
+### additionalSigners?
+
+```ts
+optional additionalSigners?: AccountInstance[];
+```
+
+### Inherited from
+
+```ts
+ModuleInstanceParams.additionalSigners
+```
+
+***
+
+### allowNameResolution?
+
+```ts
+optional allowNameResolution?: boolean;
+```
+
+### Inherited from
+
+```ts
+ModuleInstanceParams.allowNameResolution
+```
+
+***
+
+### config
+
+```ts
+config: Partial<TConfig>;
+```
+
+### Inherited from
+
+```ts
+ModuleInstanceParams.config
+```
+
+***
+
+### ephemeralQueryAccountEnabled?
+
+```ts
+optional ephemeralQueryAccountEnabled?: boolean;
+```
+
+### Inherited from
+
+```ts
+ModuleInstanceParams.ephemeralQueryAccountEnabled
+```
+
+***
+
+### moduleIdentifierTransformers?
+
+```ts
+optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
+```
+
+### Inherited from
+
+```ts
+ModuleInstanceParams.moduleIdentifierTransformers
+```
+
+***
+
+### statusReporter?
+
+```ts
+optional statusReporter?: ModuleStatusReporter;
+```
+
+Optional reporter for broadcasting status changes.
+
+### Inherited from
+
+```ts
+ModuleInstanceParams.statusReporter
+```
+
+***
+
+### privateChildren?
+
+```ts
+optional privateChildren?: ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];
+```
+
+### Inherited from
+
+```ts
+ModuleInstanceParams.privateChildren
+```
+
+***
+
+### publicChildren?
+
+```ts
+optional publicChildren?: ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];
+```
+
+### Inherited from
+
+```ts
+ModuleInstanceParams.publicChildren
+```
+
+                ### <a id="NodeModule"></a>NodeModule
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModule`\<`TParams`, `TEventData`\>
+
+## Extended by
+
+- [`AttachableNodeInstance`](#AttachableNodeInstance)
+- [`NodeInstance`](#NodeInstance)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`NodeParams`](#NodeParams) = [`NodeParams`](#NodeParams)
+
+### TEventData
+
+`TEventData` *extends* [`NodeModuleEventData`](#NodeModuleEventData) = [`NodeModuleEventData`](#NodeModuleEventData)
+
+## Properties
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+```ts
+QueryableModule.address
+```
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+```ts
+QueryableModule.config
+```
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+```ts
+QueryableModule.id
+```
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+```ts
+QueryableModule.modName
+```
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+```ts
+QueryableModule.params
+```
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+```ts
+QueryableModule.previousHash
+```
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+```ts
+QueryableModule.queries
+```
+
+***
+
+### query
+
+```ts
+query: <T, TConf>(query, payloads?, queryConfig?) => Promisable<ModuleQueryResult>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+```ts
+QueryableModule.query
+```
+
+***
+
+### queryable
+
+```ts
+queryable: <T, TConf>(query, payloads?, queryConfig?) => Promisable<boolean>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `UnsignedQueryBoundWitness` = `UnsignedQueryBoundWitness`
+
+#### TConf
+
+`TConf` *extends* `ModuleConfig` = `ModuleConfig`
+
+### Parameters
+
+#### query
+
+`T`
+
+#### payloads?
+
+`Payload`[]
+
+#### queryConfig?
+
+`TConf`
+
+### Returns
+
+`Promisable`\<`boolean`\>
+
+### Inherited from
+
+```ts
+QueryableModule.queryable
+```
+
+                ### <a id="NodeModuleEventData"></a>NodeModuleEventData
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- [`ModuleAttachedEventData`](#ModuleAttachedEventData).[`ModuleDetachedEventData`](#ModuleDetachedEventData).[`ModuleRegisteredEventData`](#ModuleRegisteredEventData).[`ModuleUnregisteredEventData`](#ModuleUnregisteredEventData).`ModuleEventData`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### moduleBusy
+
+```ts
+moduleBusy: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: object;
+```
+
+### Type Declaration
+
+#### busy
+
+```ts
+busy: boolean;
+```
+
+### Inherited from
+
+```ts
+ModuleEventData.moduleBusy
+```
+
+***
+
+### moduleError
+
+```ts
+moduleError: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: object;
+```
+
+### Type Declaration
+
+#### error
+
+```ts
+error: Error;
+```
+
+### Inherited from
+
+```ts
+ModuleEventData.moduleError
+```
+
+***
+
+### moduleQueried
+
+```ts
+moduleQueried: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: object;
+```
+
+### Type Declaration
+
+#### payloads?
+
+```ts
+optional payloads?: Payload[];
+```
+
+#### query
+
+```ts
+query: UnsignedQueryBoundWitness;
+```
+
+#### result
+
+```ts
+result: ModuleQueryResult;
+```
+
+### Inherited from
+
+```ts
+ModuleEventData.moduleQueried
+```
+
+***
+
+### moduleAttached
+
+```ts
+moduleAttached: object;
+```
+
+### mod
+
+```ts
+mod: QueryableModule;
+```
+
+### Inherited from
+
+[`ModuleAttachedEventData`](#ModuleAttachedEventData).[`moduleAttached`](ModuleAttachedEventData.md#moduleattached)
+
+***
+
+### moduleDetached
+
+```ts
+moduleDetached: object;
+```
+
+### mod
+
+```ts
+mod: QueryableModule;
+```
+
+### Inherited from
+
+[`ModuleDetachedEventData`](#ModuleDetachedEventData).[`moduleDetached`](ModuleDetachedEventData.md#moduledetached)
+
+***
+
+### moduleRegistered
+
+```ts
+moduleRegistered: object;
+```
+
+### mod
+
+```ts
+mod: QueryableModule;
+```
+
+### Inherited from
+
+[`ModuleRegisteredEventData`](#ModuleRegisteredEventData).[`moduleRegistered`](ModuleRegisteredEventData.md#moduleregistered)
+
+***
+
+### moduleUnregistered
+
+```ts
+moduleUnregistered: object;
+```
+
+### mod
+
+```ts
+mod: QueryableModule;
+```
+
+### Inherited from
+
+[`ModuleUnregisteredEventData`](#ModuleUnregisteredEventData).[`moduleUnregistered`](ModuleUnregisteredEventData.md#moduleunregistered)
+
+                ### <a id="NodeParams"></a>NodeParams
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModuleParams`\<`TConfig`\>
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* `AnyConfigSchema`\<[`NodeConfig`](#../type-aliases/NodeConfig)\> = `AnyConfigSchema`\<[`NodeConfig`](#../type-aliases/NodeConfig)\>
+
+## Properties
+
+### account?
+
+```ts
+optional account?: AccountInstance | "random";
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.account
+```
+
+***
+
+### addToResolvers?
+
+```ts
+optional addToResolvers?: boolean;
+```
+
+### Inherited from
+
+[`NodeInstanceParams`](#NodeInstanceParams).[`addToResolvers`](NodeInstanceParams.md#addtoresolvers)
+
+***
+
+### additionalSigners?
+
+```ts
+optional additionalSigners?: AccountInstance[];
+```
+
+### Inherited from
+
+[`NodeInstanceParams`](#NodeInstanceParams).[`additionalSigners`](NodeInstanceParams.md#additionalsigners)
+
+***
+
+### allowNameResolution?
+
+```ts
+optional allowNameResolution?: boolean;
+```
+
+### Inherited from
+
+[`NodeInstanceParams`](#NodeInstanceParams).[`allowNameResolution`](NodeInstanceParams.md#allownameresolution)
+
+***
+
+### config
+
+```ts
+config: Partial<TConfig>;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.config
+```
+
+***
+
+### ephemeralQueryAccountEnabled?
+
+```ts
+optional ephemeralQueryAccountEnabled?: boolean;
+```
+
+### Inherited from
+
+[`NodeInstanceParams`](#NodeInstanceParams).[`ephemeralQueryAccountEnabled`](NodeInstanceParams.md#ephemeralqueryaccountenabled)
+
+***
+
+### moduleIdentifierTransformers?
+
+```ts
+optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
+```
+
+### Inherited from
+
+[`NodeInstanceParams`](#NodeInstanceParams).[`moduleIdentifierTransformers`](NodeInstanceParams.md#moduleidentifiertransformers)
+
+***
+
+### statusReporter?
+
+```ts
+optional statusReporter?: ModuleStatusReporter;
+```
+
+Optional reporter for broadcasting status changes.
+
+### Inherited from
+
+[`NodeInstanceParams`](#NodeInstanceParams).[`statusReporter`](NodeInstanceParams.md#statusreporter)
+
+                ### <a id="NodeQueryFunctions"></a>NodeQueryFunctions
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extended by
+
+- [`NodeInstance`](#NodeInstance)
+
+## Properties
+
+### attach
+
+```ts
+attach: (id, external?) => Promise<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### external?
+
+`boolean`
+
+### Returns
+
+`Promise`\<`BrandedAddress` \| `undefined`\>
+
+***
+
+### attachQuery
+
+```ts
+attachQuery: (id, external?, account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### external?
+
+`boolean`
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+***
+
+### attached
+
+```ts
+attached: () => Promise<BrandedAddress[]>;
+```
+
+### Returns
+
+`Promise`\<`BrandedAddress`[]\>
+
+***
+
+### attachedQuery
+
+```ts
+attachedQuery: (account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+***
+
+### certify
+
+```ts
+certify: (id) => Promise<ChildCertificationFields | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+### Returns
+
+`Promise`\<[`ChildCertificationFields`](#ChildCertificationFields) \| `undefined`\>
+
+***
+
+### certifyQuery
+
+```ts
+certifyQuery: (id, account?) => Promise<ModuleQueryResult<ChildCertification>>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<[`ChildCertification`](#../type-aliases/ChildCertification)\>\>
+
+***
+
+### detach
+
+```ts
+detach: (id) => Promise<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+### Returns
+
+`Promise`\<`BrandedAddress` \| `undefined`\>
+
+***
+
+### detachQuery
+
+```ts
+detachQuery: (id, account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+***
+
+### registered
+
+```ts
+registered: () => Promise<BrandedAddress[]>;
+```
+
+### Returns
+
+`Promise`\<`BrandedAddress`[]\>
+
+***
+
+### registeredQuery
+
+```ts
+registeredQuery: (account?) => Promise<ModuleQueryResult<AddressPayload>>;
+```
+
+### Parameters
+
+#### account?
+
+`AccountInstance`
+
+### Returns
+
+`Promise`\<`ModuleQueryResult`\<`AddressPayload`\>\>
+
+                ### <a id="NodeRegistrationFunctions"></a>NodeRegistrationFunctions
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+## Extended by
+
+- [`NodeInstance`](#NodeInstance)
+
+## Properties
+
+### register?
+
+```ts
+optional register?: (mod) => Promise<void>;
+```
+
+### Parameters
+
+#### mod
+
+`AttachableModuleInstance`
+
+### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### registeredModules?
+
+```ts
+optional registeredModules?: () => AttachableModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];
+```
+
+### Returns
+
+`AttachableModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]
+
+***
+
+### unregister?
+
+```ts
+optional unregister?: (mod) => Promise<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`Promise`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>\>
+
+              ### type-aliases
+
+                ### <a id="AttachableNodeInstanceTypeCheck"></a>AttachableNodeInstanceTypeCheck
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type AttachableNodeInstanceTypeCheck<T> = TypeCheck<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`AttachableNodeInstance`](#../interfaces/AttachableNodeInstance) = [`AttachableNodeInstance`](#../interfaces/AttachableNodeInstance)
+
+                ### <a id="ChildCertification"></a>ChildCertification
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type ChildCertification = Payload<ChildCertificationFields, ChildCertificationSchema>;
+```
+
+                ### <a id="ChildCertificationSchema"></a>ChildCertificationSchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type ChildCertificationSchema = typeof ChildCertificationSchema;
+```
+
+                ### <a id="ModuleAttachedEventArgs"></a>ModuleAttachedEventArgs
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type ModuleAttachedEventArgs<TModule> = ModuleEventArgs<TModule>;
+```
+
+## Type Parameters
+
+### TModule
+
+`TModule` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="ModuleDetachedEventArgs"></a>ModuleDetachedEventArgs
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type ModuleDetachedEventArgs<TModule> = ModuleEventArgs<TModule>;
+```
+
+## Type Parameters
+
+### TModule
+
+`TModule` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="ModuleRegisteredEventArgs"></a>ModuleRegisteredEventArgs
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type ModuleRegisteredEventArgs<TModule> = ModuleEventArgs<TModule>;
+```
+
+## Type Parameters
+
+### TModule
+
+`TModule` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="ModuleUnregisteredEventArgs"></a>ModuleUnregisteredEventArgs
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type ModuleUnregisteredEventArgs<TModule> = ModuleEventArgs<TModule>;
+```
+
+## Type Parameters
+
+### TModule
+
+`TModule` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="NodeAttachQuery"></a>NodeAttachQuery
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeAttachQuery = Query<{
+  external?: boolean;
+  id: ModuleIdentifier;
+  schema: NodeAttachQuerySchema;
+}>;
+```
+
+                ### <a id="NodeAttachQuerySchema"></a>NodeAttachQuerySchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeAttachQuerySchema = typeof NodeAttachQuerySchema;
+```
+
+                ### <a id="NodeAttachedQuery"></a>NodeAttachedQuery
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeAttachedQuery = Query<{
+  schema: NodeAttachedQuerySchema;
+}>;
+```
+
+                ### <a id="NodeAttachedQuerySchema"></a>NodeAttachedQuerySchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeAttachedQuerySchema = typeof NodeAttachedQuerySchema;
+```
+
+                ### <a id="NodeCertifyQuery"></a>NodeCertifyQuery
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeCertifyQuery = Query<{
+  id: ModuleIdentifier;
+  schema: NodeCertifyQuerySchema;
+}>;
+```
+
+                ### <a id="NodeCertifyQuerySchema"></a>NodeCertifyQuerySchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeCertifyQuerySchema = typeof NodeCertifyQuerySchema;
+```
+
+                ### <a id="NodeConfig"></a>NodeConfig
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeConfig<TConfig, TSchema> = ModuleConfig<WithAdditional<{
+  archivist?: string;
+}, TConfig>, TSchema extends void ? TConfig extends Payload ? TConfig["schema"] : NodeConfigSchema : TSchema>;
+```
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* `EmptyObject` \| `Payload` \| `void` = `void`
+
+### TSchema
+
+`TSchema` *extends* `Schema` \| `void` = `void`
+
+                ### <a id="NodeConfigSchema"></a>NodeConfigSchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeConfigSchema = typeof NodeConfigSchema;
+```
+
+                ### <a id="NodeDetachQuery"></a>NodeDetachQuery
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeDetachQuery = Query<{
+  id: ModuleIdentifier;
+  schema: NodeDetachQuerySchema;
+}>;
+```
+
+                ### <a id="NodeDetachQuerySchema"></a>NodeDetachQuerySchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeDetachQuerySchema = typeof NodeDetachQuerySchema;
+```
+
+                ### <a id="NodeModuleQueries"></a>NodeModuleQueries
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeModuleQueries = ModuleQueries | NodeQueries;
+```
+
+                ### <a id="NodeQueries"></a>NodeQueries
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeQueries = 
+  | NodeAttachQuery
+  | NodeCertifyQuery
+  | NodeDetachQuery
+  | NodeAttachedQuery
+  | NodeRegisteredQuery;
+```
+
+                ### <a id="NodeRegisteredQuery"></a>NodeRegisteredQuery
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeRegisteredQuery = Query<{
+  schema: NodeRegisteredQuerySchema;
+}>;
+```
+
+                ### <a id="NodeRegisteredQuerySchema"></a>NodeRegisteredQuerySchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+type NodeRegisteredQuerySchema = typeof NodeRegisteredQuerySchema;
+```
+
+              ### variables
+
+                ### <a id="ChildCertificationSchema"></a>ChildCertificationSchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const ChildCertificationSchema: "network.xyo.child.certification" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="NodeAttachQuerySchema"></a>NodeAttachQuerySchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const NodeAttachQuerySchema: "network.xyo.query.node.attach" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="NodeAttachedQuerySchema"></a>NodeAttachedQuerySchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const NodeAttachedQuerySchema: "network.xyo.query.node.attached" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="NodeCertifyQuerySchema"></a>NodeCertifyQuerySchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const NodeCertifyQuerySchema: "network.xyo.query.node.certify" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="NodeConfigSchema"></a>NodeConfigSchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const NodeConfigSchema: "network.xyo.node.config" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="NodeDetachQuerySchema"></a>NodeDetachQuerySchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const NodeDetachQuerySchema: "network.xyo.query.node.detach" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="NodeRegisteredQuerySchema"></a>NodeRegisteredQuerySchema
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const NodeRegisteredQuerySchema: "network.xyo.query.node.registered" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="asAttachableNodeInstance"></a>asAttachableNodeInstance
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const asAttachableNodeInstance: AsTypeFunction<AttachableNodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>>;
+```
+
+                ### <a id="asNodeInstance"></a>asNodeInstance
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const asNodeInstance: AsTypeFunction<NodeInstance<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>>;
+```
+
+                ### <a id="asNodeModule"></a>asNodeModule
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const asNodeModule: AsTypeFunction<NodeModule<NodeParams<AnyConfigSchema<NodeConfig>>, NodeModuleEventData>>;
+```
+
+                ### <a id="isAttachableNodeInstance"></a>isAttachableNodeInstance
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const isAttachableNodeInstance: TypeCheck<AttachableNodeInstance>;
+```
+
+                ### <a id="isNodeInstance"></a>isNodeInstance
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const isNodeInstance: TypeCheck<NodeInstance>;
+```
+
+                ### <a id="isNodeModule"></a>isNodeModule
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const isNodeModule: TypeCheck<NodeModule>;
+```
+
+                ### <a id="requiredAttachableNodeInstanceFunctions"></a>requiredAttachableNodeInstanceFunctions
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const requiredAttachableNodeInstanceFunctions: ObjectTypeShape = {};
+```
+
+                ### <a id="withNodeInstance"></a>withNodeInstance
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const withNodeInstance: <R>(mod, closure) => R | undefined;
+```
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Parameters
+
+### mod
+
+`any`
+
+### closure
+
+(`mod`) => `R`
+
+## Returns
+
+`R` \| `undefined`
+
+## Deprecated
+
+use narrowing instead [ if(is) ]
+
+                ### <a id="withNodeModule"></a>withNodeModule
+
+[**@xyo-network/node-model**](#../README)
+
+***
+
+```ts
+const withNodeModule: <R>(mod, closure) => R | undefined;
+```
+
+## Type Parameters
+
+### R
+
+`R`
+
+## Parameters
+
+### mod
+
+`any`
+
+### closure
+
+(`mod`) => `R`
+
+## Returns
+
+`R` \| `undefined`
+
+## Deprecated
 
-## Credits
+use narrowing instead [ if(is) ]
 
-[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/node-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/node-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/node-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE