@xyo-network/bridge-model 5.3.25 → 5.3.26

package/README.md

@@ -1,23 +1,3667 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/bridge-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__bridge-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
+
+      ### bridge
+
+        ### packages
+
+          ### model
+
+            ### .temp-typedoc
+
+              ### classes
+
+                ### <a id="IsAttachableBridgeInstanceFactory"></a>IsAttachableBridgeInstanceFactory
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- `IsObjectFactory`\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`AttachableBridgeInstance`](#../interfaces/AttachableBridgeInstance) = [`AttachableBridgeInstance`](#../interfaces/AttachableBridgeInstance)
+
+## Constructors
+
+### Constructor
+
+```ts
+new IsAttachableBridgeInstanceFactory<T>(): IsAttachableBridgeInstanceFactory<T>;
+```
+
+### Returns
+
+`IsAttachableBridgeInstanceFactory`\<`T`\>
+
+### Inherited from
+
+```ts
+IsObjectFactory<T>.constructor
+```
+
+              ### interfaces
+
+                ### <a id="AttachableBridgeInstance"></a>AttachableBridgeInstance
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- [`BridgeModule`](#BridgeModule)\<`TParams`, `TEventData`\>.`AttachableModuleInstance`\<`TParams`, `TEventData`\>.[`BridgeInstance`](#BridgeInstance)\<`TParams`, `TEventData`\>
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`BridgeParams`](#BridgeParams) = [`BridgeParams`](#BridgeParams)
+
+### TEventData
+
+`TEventData` *extends* [`BridgeModuleEventData`](#BridgeModuleEventData) = [`BridgeModuleEventData`](#BridgeModuleEventData)
+
+## Properties
+
+### exposed?
+
+```ts
+optional exposed?: () => Promisable<BrandedAddress[]>;
+```
+
+### Returns
+
+`Promisable`\<`BrandedAddress`[]\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`exposed`](BridgeInstance.md#exposed)
+
+***
+
+### connect?
+
+```ts
+optional connect?: (id, maxDepth?) => Promisable<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### maxDepth?
+
+`number`
+
+### Returns
+
+`Promisable`\<`BrandedAddress` \| `undefined`\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`connect`](BridgeInstance.md#connect)
+
+***
+
+### disconnect?
+
+```ts
+optional disconnect?: (id, maxDepth?) => Promisable<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### maxDepth?
+
+`number`
+
+### Returns
+
+`Promisable`\<`BrandedAddress` \| `undefined`\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`disconnect`](BridgeInstance.md#disconnect)
+
+***
+
+### expose
+
+```ts
+expose: (id, options?) => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### options?
+
+[`BridgeExposeOptions`](#BridgeExposeOptions)
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`expose`](BridgeInstance.md#expose)
+
+***
+
+### unexpose?
+
+```ts
+optional unexpose?: (id, options?) => Promisable<BrandedAddress[]>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### options?
+
+[`BridgeUnexposeOptions`](#BridgeUnexposeOptions)
+
+### Returns
+
+`Promisable`\<`BrandedAddress`[]\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`unexpose`](BridgeInstance.md#unexpose)
+
+***
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`address`](BridgeModule.md#address)
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`config`](BridgeModule.md#config)
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`id`](BridgeInstance.md#id)
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`modName`](BridgeInstance.md#modname)
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`params`](BridgeModule.md#params)
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`previousHash`](BridgeModule.md#previoushash)
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`queries`](BridgeInstance.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
+
+[`BridgeModule`](#BridgeModule).[`query`](BridgeModule.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
+
+[`BridgeModule`](#BridgeModule).[`queryable`](BridgeModule.md#queryable)
+
+***
+
+### manifest
+
+```ts
+manifest: (maxDepth?, ignoreAddresses?) => Promisable<ModuleManifestPayload>;
+```
+
+### Parameters
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleManifestPayload`\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`manifest`](BridgeInstance.md#manifest)
+
+***
+
+### manifestQuery
+
+```ts
+manifestQuery: (account, maxDepth?, ignoreAddresses?) => Promisable<ModuleQueryResult<ModuleManifestPayload>>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+#### maxDepth?
+
+`number`
+
+#### ignoreAddresses?
+
+`BrandedAddress`[]
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\<`ModuleManifestPayload`\>\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`manifestQuery`](BridgeInstance.md#manifestquery)
+
+***
+
+### moduleAddress
+
+```ts
+moduleAddress: () => Promisable<(AddressPreviousHashPayload | AddressPayload)[]>;
+```
+
+### Returns
+
+`Promisable`\<(`AddressPreviousHashPayload` \| `AddressPayload`)[]\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`moduleAddress`](BridgeInstance.md#moduleaddress)
+
+***
+
+### state
+
+```ts
+state: () => Promisable<Payload[]>;
+```
+
+### Returns
+
+`Promisable`\<`Payload`[]\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`state`](BridgeInstance.md#state)
+
+***
+
+### stateQuery
+
+```ts
+stateQuery: (account) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### account
+
+`AccountInstance`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`stateQuery`](BridgeInstance.md#statequery)
+
+***
+
+### account?
+
+```ts
+optional account?: AccountInstance;
+```
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`account`](BridgeInstance.md#account)
+
+***
+
+### addParent
+
+```ts
+addParent: (mod) => void;
+```
+
+### Parameters
+
+#### mod
+
+`ModuleInstance`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`addParent`](BridgeInstance.md#addparent)
+
+***
+
+### addressCache?
+
+```ts
+optional addressCache?: (direction, includePrivate) => AddressToWeakInstanceCache | undefined;
+```
+
+### Parameters
+
+#### direction
+
+`Direction`
+
+#### includePrivate
+
+`boolean`
+
+### Returns
+
+`AddressToWeakInstanceCache` \| `undefined`
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`addressCache`](BridgeInstance.md#addresscache)
+
+***
+
+### parents
+
+```ts
+parents: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`parents`](BridgeInstance.md#parents)
+
+***
+
+### privateChildren
+
+```ts
+privateChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`privateChildren`](BridgeInstance.md#privatechildren)
+
+***
+
+### publicChildren
+
+```ts
+publicChildren: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`publicChildren`](BridgeInstance.md#publicchildren)
+
+***
+
+### removeParent
+
+```ts
+removeParent: (address) => void;
+```
+
+### Parameters
+
+#### address
+
+`BrandedAddress`
+
+### Returns
+
+`void`
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`removeParent`](BridgeInstance.md#removeparent)
+
+***
+
+### siblings
+
+```ts
+siblings: () => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`siblings`](BridgeInstance.md#siblings)
+
+***
+
+### pipeline?
+
+```ts
+readonly optional pipeline?: "one-to-one" | "one-to-many" | "many-to-one" | "many-to-many";
+```
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`pipeline`](BridgeInstance.md#pipeline)
+
+***
+
+### status
+
+```ts
+readonly status: ModuleStatus | null;
+```
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`status`](BridgeInstance.md#status)
+
+***
+
+### priority
+
+```ts
+priority: ObjectResolverPriority;
+```
+
+### Inherited from
+
+[`BridgeInstance`](#BridgeInstance).[`priority`](BridgeInstance.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
+```
+
+## 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
+
+[`BridgeInstance`](#BridgeInstance).[`resolve`](BridgeInstance.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
+
+[`BridgeInstance`](#BridgeInstance).[`resolve`](BridgeInstance.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
+
+[`BridgeInstance`](#BridgeInstance).[`resolve`](BridgeInstance.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
+
+[`BridgeInstance`](#BridgeInstance).[`resolvePrivate`](BridgeInstance.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
+
+[`BridgeInstance`](#BridgeInstance).[`resolvePrivate`](BridgeInstance.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
+
+[`BridgeInstance`](#BridgeInstance).[`resolvePrivate`](BridgeInstance.md#resolveprivate)
+
+                ### <a id="BridgeExposeOptions"></a>BridgeExposeOptions
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extended by
+
+- [`BridgeUnexposeOptions`](#BridgeUnexposeOptions)
+
+## Properties
+
+### maxDepth?
+
+```ts
+optional maxDepth?: number;
+```
+
+***
+
+### required?
+
+```ts
+optional required?: boolean;
+```
+
+                ### <a id="BridgeInstance"></a>BridgeInstance
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- [`BridgeModule`](#BridgeModule)\<`TParams`, `TEventData`\>.[`BridgeQueryFunctions`](#BridgeQueryFunctions).`ModuleInstance`\<`TParams`, `TEventData`\>
+
+## Extended by
+
+- [`AttachableBridgeInstance`](#AttachableBridgeInstance)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`BridgeParams`](#BridgeParams) = [`BridgeParams`](#BridgeParams)
+
+### TEventData
+
+`TEventData` *extends* [`BridgeModuleEventData`](#BridgeModuleEventData) = [`BridgeModuleEventData`](#BridgeModuleEventData)
+
+## Properties
+
+### exposed?
+
+```ts
+optional exposed?: () => Promisable<BrandedAddress[]>;
+```
+
+### Returns
+
+`Promisable`\<`BrandedAddress`[]\>
+
+***
+
+### connect?
+
+```ts
+optional connect?: (id, maxDepth?) => Promisable<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### maxDepth?
+
+`number`
+
+### Returns
+
+`Promisable`\<`BrandedAddress` \| `undefined`\>
+
+### Inherited from
+
+[`BridgeQueryFunctions`](#BridgeQueryFunctions).[`connect`](BridgeQueryFunctions.md#connect)
+
+***
+
+### disconnect?
+
+```ts
+optional disconnect?: (id, maxDepth?) => Promisable<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### maxDepth?
+
+`number`
+
+### Returns
+
+`Promisable`\<`BrandedAddress` \| `undefined`\>
+
+### Inherited from
+
+[`BridgeQueryFunctions`](#BridgeQueryFunctions).[`disconnect`](BridgeQueryFunctions.md#disconnect)
+
+***
+
+### expose
+
+```ts
+expose: (id, options?) => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### options?
+
+[`BridgeExposeOptions`](#BridgeExposeOptions)
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+### Inherited from
+
+[`BridgeQueryFunctions`](#BridgeQueryFunctions).[`expose`](BridgeQueryFunctions.md#expose)
+
+***
+
+### unexpose?
+
+```ts
+optional unexpose?: (id, options?) => Promisable<BrandedAddress[]>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### options?
+
+[`BridgeUnexposeOptions`](#BridgeUnexposeOptions)
+
+### Returns
+
+`Promisable`\<`BrandedAddress`[]\>
+
+### Inherited from
+
+[`BridgeQueryFunctions`](#BridgeQueryFunctions).[`unexpose`](BridgeQueryFunctions.md#unexpose)
+
+***
+
+### address
+
+```ts
+address: BrandedAddress;
+```
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`address`](BridgeModule.md#address)
+
+***
+
+### config
+
+```ts
+config: TParams["config"];
+```
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`config`](BridgeModule.md#config)
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+The name (if specified) or address of the module
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`id`](BridgeModule.md#id)
+
+***
+
+### modName?
+
+```ts
+optional modName?: string;
+```
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`modName`](BridgeModule.md#modname)
+
+***
+
+### params
+
+```ts
+params: TParams;
+```
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`params`](BridgeModule.md#params)
+
+***
+
+### previousHash
+
+```ts
+previousHash: () => Promisable<string | undefined>;
+```
+
+### Returns
+
+`Promisable`\<`string` \| `undefined`\>
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`previousHash`](BridgeModule.md#previoushash)
+
+***
+
+### queries
+
+```ts
+queries: string[];
+```
+
+### Inherited from
+
+[`BridgeModule`](#BridgeModule).[`queries`](BridgeModule.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
+
+[`BridgeModule`](#BridgeModule).[`query`](BridgeModule.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
+
+[`BridgeModule`](#BridgeModule).[`queryable`](BridgeModule.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
+```
+
+## 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="BridgeModule"></a>BridgeModule
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModule`\<`TParams`, `TEventData`\>
+
+## Extended by
+
+- [`AttachableBridgeInstance`](#AttachableBridgeInstance)
+- [`BridgeInstance`](#BridgeInstance)
+
+## Type Parameters
+
+### TParams
+
+`TParams` *extends* [`BridgeParams`](#BridgeParams) = [`BridgeParams`](#BridgeParams)
+
+### TEventData
+
+`TEventData` *extends* [`BridgeModuleEventData`](#BridgeModuleEventData) = [`BridgeModuleEventData`](#BridgeModuleEventData)
+
+## 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="BridgeModuleEventData"></a>BridgeModuleEventData
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- [`QuerySendFinishedEventData`](#QuerySendFinishedEventData).[`QuerySendStartedEventData`](#QuerySendStartedEventData).[`QueryFulfillFinishedEventData`](#QueryFulfillFinishedEventData).[`QueryFulfillStartedEventData`](#QueryFulfillStartedEventData).[`ExposedEventData`](#ExposedEventData).[`UnexposedEventData`](#UnexposedEventData).`ModuleEventData`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### exposed
+
+```ts
+exposed: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: QueryableModule;
+```
+
+### Type Declaration
+
+#### modules
+
+```ts
+modules: ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];
+```
+
+### Inherited from
+
+[`ExposedEventData`](#ExposedEventData).[`exposed`](ExposedEventData.md#exposed)
+
+***
+
+### queryFulfillFinished
+
+```ts
+queryFulfillFinished: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: QueryableModule;
+```
+
+### Type Declaration
+
+#### payloads?
+
+```ts
+optional payloads?: Payload[];
+```
+
+#### query
+
+```ts
+query: UnsignedQueryBoundWitness;
+```
+
+#### result?
+
+```ts
+optional result?: ModuleQueryResult;
+```
+
+#### status
+
+```ts
+status: "success" | "failure";
+```
+
+### Inherited from
+
+[`QueryFulfillFinishedEventData`](#QueryFulfillFinishedEventData).[`queryFulfillFinished`](QueryFulfillFinishedEventData.md#queryfulfillfinished)
+
+***
+
+### queryFulfillStarted
+
+```ts
+queryFulfillStarted: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: QueryableModule;
+```
+
+### Type Declaration
+
+#### payloads?
+
+```ts
+optional payloads?: Payload[];
+```
+
+#### query
+
+```ts
+query: UnsignedQueryBoundWitness;
+```
+
+### Inherited from
+
+[`QueryFulfillStartedEventData`](#QueryFulfillStartedEventData).[`queryFulfillStarted`](QueryFulfillStartedEventData.md#queryfulfillstarted)
+
+***
+
+### querySendFinished
+
+```ts
+querySendFinished: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: QueryableModule;
+```
+
+### Type Declaration
+
+#### payloads?
+
+```ts
+optional payloads?: Payload[];
+```
+
+#### query
+
+```ts
+query: UnsignedQueryBoundWitness;
+```
+
+#### result?
+
+```ts
+optional result?: ModuleQueryResult;
+```
+
+#### status
+
+```ts
+status: "success" | "failure";
+```
+
+### Inherited from
+
+[`QuerySendFinishedEventData`](#QuerySendFinishedEventData).[`querySendFinished`](QuerySendFinishedEventData.md#querysendfinished)
+
+***
+
+### querySendStarted
+
+```ts
+querySendStarted: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: QueryableModule;
+```
+
+### Type Declaration
+
+#### payloads?
+
+```ts
+optional payloads?: Payload[];
+```
+
+#### query
+
+```ts
+query: UnsignedQueryBoundWitness;
+```
+
+### Inherited from
+
+[`QuerySendStartedEventData`](#QuerySendStartedEventData).[`querySendStarted`](QuerySendStartedEventData.md#querysendstarted)
+
+***
+
+### unexposed
+
+```ts
+unexposed: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: QueryableModule;
+```
+
+### Type Declaration
+
+#### modules
+
+```ts
+modules: ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];
+```
+
+### Inherited from
+
+[`UnexposedEventData`](#UnexposedEventData).[`unexposed`](UnexposedEventData.md#unexposed)
+
+***
+
+### 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
+```
+
+                ### <a id="BridgeParams"></a>BridgeParams
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- `QueryableModuleParams`\<`TConfig`\>
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* `AnyConfigSchema`\<[`BridgeConfig`](#../type-aliases/BridgeConfig)\> = `AnyConfigSchema`\<[`BridgeConfig`](#../type-aliases/BridgeConfig)\>
+
+## Properties
+
+### resolver?
+
+```ts
+optional resolver?: ModuleResolverInstance<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>>;
+```
+
+***
+
+### account?
+
+```ts
+optional account?: AccountInstance | "random";
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.account
+```
+
+***
+
+### addToResolvers?
+
+```ts
+optional addToResolvers?: boolean;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.addToResolvers
+```
+
+***
+
+### additionalSigners?
+
+```ts
+optional additionalSigners?: AccountInstance[];
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.additionalSigners
+```
+
+***
+
+### allowNameResolution?
+
+```ts
+optional allowNameResolution?: boolean;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.allowNameResolution
+```
+
+***
+
+### config
+
+```ts
+config: Partial<TConfig>;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.config
+```
+
+***
+
+### ephemeralQueryAccountEnabled?
+
+```ts
+optional ephemeralQueryAccountEnabled?: boolean;
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.ephemeralQueryAccountEnabled
+```
+
+***
+
+### moduleIdentifierTransformers?
+
+```ts
+optional moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
+```
+
+### Inherited from
+
+```ts
+QueryableModuleParams.moduleIdentifierTransformers
+```
+
+***
+
+### statusReporter?
+
+```ts
+optional statusReporter?: ModuleStatusReporter;
+```
+
+Optional reporter for broadcasting status changes.
+
+### Inherited from
+
+```ts
+QueryableModuleParams.statusReporter
+```
+
+                ### <a id="BridgeQueryFunctions"></a>BridgeQueryFunctions
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extended by
+
+- [`BridgeInstance`](#BridgeInstance)
+
+## Properties
+
+### connect?
+
+```ts
+optional connect?: (id, maxDepth?) => Promisable<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### maxDepth?
+
+`number`
+
+### Returns
+
+`Promisable`\<`BrandedAddress` \| `undefined`\>
+
+***
+
+### disconnect?
+
+```ts
+optional disconnect?: (id, maxDepth?) => Promisable<BrandedAddress | undefined>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### maxDepth?
+
+`number`
+
+### Returns
+
+`Promisable`\<`BrandedAddress` \| `undefined`\>
+
+***
+
+### expose
+
+```ts
+expose: (id, options?) => Promisable<ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[]>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### options?
+
+[`BridgeExposeOptions`](#BridgeExposeOptions)
+
+### Returns
+
+`Promisable`\<`ModuleInstance`\<`QueryableModuleParams`\<`AnyConfigSchema`\<`ModuleConfig`\>\>, `ModuleEventData`\<`object`\>\>[]\>
+
+***
+
+### unexpose?
+
+```ts
+optional unexpose?: (id, options?) => Promisable<BrandedAddress[]>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### options?
+
+[`BridgeUnexposeOptions`](#BridgeUnexposeOptions)
+
+### Returns
+
+`Promisable`\<`BrandedAddress`[]\>
+
+                ### <a id="BridgeRawQueryFunctions"></a>BridgeRawQueryFunctions
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Properties
+
+### connectQuery?
+
+```ts
+optional connectQuery?: (id, maxDepth?) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### maxDepth?
+
+`number`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+***
+
+### disconnectQuery?
+
+```ts
+optional disconnectQuery?: (id, maxDepth?) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### maxDepth?
+
+`number`
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+***
+
+### exposeQuery
+
+```ts
+exposeQuery: (id, options?) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### options?
+
+[`BridgeExposeOptions`](#BridgeExposeOptions)
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+***
+
+### unexposeQuery?
+
+```ts
+optional unexposeQuery?: (id, options?) => Promisable<ModuleQueryResult>;
+```
+
+### Parameters
+
+#### id
+
+`ModuleIdentifier`
+
+#### options?
+
+[`BridgeUnexposeOptions`](#BridgeUnexposeOptions)
+
+### Returns
+
+`Promisable`\<`ModuleQueryResult`\>
+
+                ### <a id="BridgeUnexposeOptions"></a>BridgeUnexposeOptions
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- [`BridgeExposeOptions`](#BridgeExposeOptions)
+
+## Properties
+
+### maxDepth?
+
+```ts
+optional maxDepth?: number;
+```
+
+### Inherited from
+
+[`BridgeExposeOptions`](#BridgeExposeOptions).[`maxDepth`](BridgeExposeOptions.md#maxdepth)
+
+***
+
+### required?
+
+```ts
+optional required?: boolean;
+```
+
+### Inherited from
+
+[`BridgeExposeOptions`](#BridgeExposeOptions).[`required`](BridgeExposeOptions.md#required)
+
+                ### <a id="ExposedEventData"></a>ExposedEventData
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`BridgeModuleEventData`](#BridgeModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### exposed
+
+```ts
+exposed: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### modules
+
+```ts
+modules: ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];
+```
+
+                ### <a id="QueryFulfillFinishedEventData"></a>QueryFulfillFinishedEventData
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`BridgeModuleEventData`](#BridgeModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### queryFulfillFinished
+
+```ts
+queryFulfillFinished: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### payloads?
+
+```ts
+optional payloads?: Payload[];
+```
+
+#### query
+
+```ts
+query: UnsignedQueryBoundWitness;
+```
+
+#### result?
+
+```ts
+optional result?: ModuleQueryResult;
+```
+
+#### status
+
+```ts
+status: "success" | "failure";
+```
+
+                ### <a id="QueryFulfillStartedEventData"></a>QueryFulfillStartedEventData
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`BridgeModuleEventData`](#BridgeModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### queryFulfillStarted
+
+```ts
+queryFulfillStarted: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### payloads?
+
+```ts
+optional payloads?: Payload[];
+```
+
+#### query
+
+```ts
+query: UnsignedQueryBoundWitness;
+```
+
+                ### <a id="QuerySendFinishedEventData"></a>QuerySendFinishedEventData
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`BridgeModuleEventData`](#BridgeModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### querySendFinished
+
+```ts
+querySendFinished: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### payloads?
+
+```ts
+optional payloads?: Payload[];
+```
+
+#### query
+
+```ts
+query: UnsignedQueryBoundWitness;
+```
+
+#### result?
+
+```ts
+optional result?: ModuleQueryResult;
+```
+
+#### status
+
+```ts
+status: "success" | "failure";
+```
+
+                ### <a id="QuerySendStartedEventData"></a>QuerySendStartedEventData
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`BridgeModuleEventData`](#BridgeModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### querySendStarted
+
+```ts
+querySendStarted: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### payloads?
+
+```ts
+optional payloads?: Payload[];
+```
+
+#### query
+
+```ts
+query: UnsignedQueryBoundWitness;
+```
+
+                ### <a id="UnexposedEventData"></a>UnexposedEventData
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+## Extends
+
+- `EventData`
+
+## Extended by
+
+- [`BridgeModuleEventData`](#BridgeModuleEventData)
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+## Indexable
+
+```ts
+[key: string | number | symbol]: EventArgs
+```
+
+## Properties
+
+### unexposed
+
+```ts
+unexposed: object & object;
+```
+
+### Type Declaration
+
+#### mod
+
+```ts
+mod: T;
+```
+
+### Type Declaration
+
+#### modules
+
+```ts
+modules: ModuleInstance<QueryableModuleParams<AnyConfigSchema<ModuleConfig>>, ModuleEventData<object>>[];
+```
+
+              ### type-aliases
+
+                ### <a id="AttachableBridgeInstanceTypeCheck"></a>AttachableBridgeInstanceTypeCheck
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type AttachableBridgeInstanceTypeCheck<T> = TypeCheck<T>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* [`AttachableBridgeInstance`](#../interfaces/AttachableBridgeInstance) = [`AttachableBridgeInstance`](#../interfaces/AttachableBridgeInstance)
+
+                ### <a id="BridgeClientConfig"></a>BridgeClientConfig
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeClientConfig = object;
+```
+
+## Properties
+
+### cache?
+
+```ts
+optional cache?: CacheConfig | true;
+```
+
+***
+
+### discoverRoots?
+
+```ts
+optional discoverRoots?: "start" | "lazy";
+```
+
+***
+
+### maxDepth?
+
+```ts
+optional maxDepth?: number;
+```
+
+                ### <a id="BridgeConfig"></a>BridgeConfig
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeConfig<TConfig, TSchema, TClient, THost> = ModuleConfig<WithAdditional<{
+  client?: WithAdditional<BridgeClientConfig, TClient>;
+  host?: WithAdditional<BridgeHostConfig, THost>;
+  schema: TConfig extends Payload ? TConfig["schema"] : BridgeConfigSchema;
+}, TConfig>, TSchema>;
+```
+
+## Type Parameters
+
+### TConfig
+
+`TConfig` *extends* `Payload` \| `EmptyObject` \| `void` = `void`
+
+### TSchema
+
+`TSchema` *extends* `Schema` \| `void` = `void`
+
+### TClient
+
+`TClient` *extends* `EmptyObject` \| `void` = `void`
+
+### THost
+
+`THost` *extends* `EmptyObject` \| `void` = `void`
+
+                ### <a id="BridgeConfigSchema"></a>BridgeConfigSchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeConfigSchema = typeof BridgeConfigSchema;
+```
+
+                ### <a id="BridgeConnectQuery"></a>BridgeConnectQuery
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeConnectQuery = Query<{
+  id?: ModuleIdentifier;
+  maxDepth?: number;
+  schema: BridgeConnectQuerySchema;
+}>;
+```
+
+                ### <a id="BridgeConnectQuerySchema"></a>BridgeConnectQuerySchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeConnectQuerySchema = typeof BridgeConnectQuerySchema;
+```
+
+                ### <a id="BridgeDisconnectQuery"></a>BridgeDisconnectQuery
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeDisconnectQuery = Query<{
+  id?: ModuleIdentifier;
+  maxDepth?: number;
+  schema: BridgeDisconnectQuerySchema;
+}>;
+```
+
+                ### <a id="BridgeDisconnectQuerySchema"></a>BridgeDisconnectQuerySchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeDisconnectQuerySchema = typeof BridgeDisconnectQuerySchema;
+```
+
+                ### <a id="BridgeExposeQuery"></a>BridgeExposeQuery
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeExposeQuery = Query<void, BridgeExposeQuerySchema>;
+```
+
+                ### <a id="BridgeExposeQuerySchema"></a>BridgeExposeQuerySchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeExposeQuerySchema = typeof BridgeExposeQuerySchema;
+```
+
+                ### <a id="BridgeHostConfig"></a>BridgeHostConfig
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeHostConfig = object;
+```
+
+## Properties
+
+### cache?
+
+```ts
+optional cache?: CacheConfig | true;
+```
+
+***
+
+### maxDepth?
+
+```ts
+optional maxDepth?: number;
+```
+
+                ### <a id="BridgeModuleQueries"></a>BridgeModuleQueries
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeModuleQueries = ModuleQueries | BridgeQueries;
+```
+
+                ### <a id="BridgeQueries"></a>BridgeQueries
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeQueries = 
+  | BridgeConnectQuery
+  | BridgeDisconnectQuery
+  | BridgeExposeQuery
+  | BridgeUnexposeQuery;
+```
+
+                ### <a id="BridgeUnexposeQuery"></a>BridgeUnexposeQuery
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeUnexposeQuery = Query<void, BridgeUnexposeQuerySchema>;
+```
+
+                ### <a id="BridgeUnexposeQuerySchema"></a>BridgeUnexposeQuerySchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type BridgeUnexposeQuerySchema = typeof BridgeUnexposeQuerySchema;
+```
+
+                ### <a id="ExposedEventArgs"></a>ExposedEventArgs
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type ExposedEventArgs<T> = ModuleEventArgs<T, {
+  modules: ModuleInstance[];
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="ModuleFilterPayload"></a>ModuleFilterPayload
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type ModuleFilterPayload = Payload<object & BridgeExposeOptions, ModuleFilterPayloadSchema>;
+```
+
+                ### <a id="ModuleFilterPayloadSchema"></a>ModuleFilterPayloadSchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type ModuleFilterPayloadSchema = typeof ModuleFilterPayloadSchema;
+```
+
+                ### <a id="QueryFulfillFinishedEventArgs"></a>QueryFulfillFinishedEventArgs
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type QueryFulfillFinishedEventArgs<T> = ModuleEventArgs<T, {
+  payloads?: Payload[];
+  query: QueryBoundWitness;
+  result?: ModuleQueryResult;
+  status: "success" | "failure";
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="QueryFulfillStartedEventArgs"></a>QueryFulfillStartedEventArgs
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type QueryFulfillStartedEventArgs<T> = ModuleEventArgs<T, {
+  payloads?: Payload[];
+  query: QueryBoundWitness;
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="QuerySendFinishedEventArgs"></a>QuerySendFinishedEventArgs
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type QuerySendFinishedEventArgs<T> = ModuleEventArgs<T, {
+  payloads?: Payload[];
+  query: QueryBoundWitness;
+  result?: ModuleQueryResult;
+  status: "success" | "failure";
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="QuerySendStartedEventArgs"></a>QuerySendStartedEventArgs
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type QuerySendStartedEventArgs<T> = ModuleEventArgs<T, {
+  payloads?: Payload[];
+  query: QueryBoundWitness;
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+                ### <a id="UnexposedEventArgs"></a>UnexposedEventArgs
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+type UnexposedEventArgs<T> = ModuleEventArgs<T, {
+  modules: ModuleInstance[];
+}>;
+```
+
+## Type Parameters
+
+### T
+
+`T` *extends* `QueryableModule` = `QueryableModule`
+
+              ### variables
+
+                ### <a id="BridgeConfigSchema"></a>BridgeConfigSchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const BridgeConfigSchema: "network.xyo.bridge.config" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="BridgeConnectQuerySchema"></a>BridgeConnectQuerySchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const BridgeConnectQuerySchema: "network.xyo.query.bridge.connect" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="BridgeDisconnectQuerySchema"></a>BridgeDisconnectQuerySchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const BridgeDisconnectQuerySchema: "network.xyo.query.bridge.disconnect" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="BridgeExposeQuerySchema"></a>BridgeExposeQuerySchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const BridgeExposeQuerySchema: "network.xyo.query.bridge.expose" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="BridgeUnexposeQuerySchema"></a>BridgeUnexposeQuerySchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const BridgeUnexposeQuerySchema: "network.xyo.query.bridge.unexpose" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="ModuleFilterPayloadSchema"></a>ModuleFilterPayloadSchema
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const ModuleFilterPayloadSchema: "network.xyo.module.filter" & object;
+```
+
+## Type Declaration
+
+### \_\_schema
+
+```ts
+readonly __schema: true;
+```
+
+                ### <a id="asAttachableBridgeInstance"></a>asAttachableBridgeInstance
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const asAttachableBridgeInstance: AsTypeFunction<AttachableBridgeInstance<BridgeParams<AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
+```
+
+                ### <a id="asBridgeInstance"></a>asBridgeInstance
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const asBridgeInstance: AsTypeFunction<BridgeInstance<BridgeParams<AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
+```
+
+                ### <a id="asBridgeModule"></a>asBridgeModule
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const asBridgeModule: AsTypeFunction<BridgeModule<BridgeParams<AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
+```
+
+                ### <a id="isAttachableBridgeInstance"></a>isAttachableBridgeInstance
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const isAttachableBridgeInstance: TypeCheck<AttachableBridgeInstance>;
+```
+
+                ### <a id="isBridgeInstance"></a>isBridgeInstance
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const isBridgeInstance: TypeCheck<BridgeInstance<BridgeParams<AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
+```
+
+                ### <a id="isBridgeModule"></a>isBridgeModule
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const isBridgeModule: QueryableModuleTypeCheck<BridgeModule<BridgeParams<AnyConfigSchema<BridgeConfig>>, BridgeModuleEventData>>;
+```
+
+                ### <a id="requiredAttachableBridgeInstanceFunctions"></a>requiredAttachableBridgeInstanceFunctions
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const requiredAttachableBridgeInstanceFunctions: ObjectTypeShape = {};
+```
+
+                ### <a id="withBridgeInstance"></a>withBridgeInstance
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const withBridgeInstance: <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="withBridgeModule"></a>withBridgeModule
+
+[**@xyo-network/bridge-model**](#../README)
+
+***
+
+```ts
+const withBridgeModule: <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/bridge-model.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/bridge-model
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/bridge-model.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE