@xyo-network/module-model 2.72.8 → 2.73.0

package/dist/index.d.mts

@@ -0,0 +1,330 @@
+import { WithAdditional, AnyObject, BaseParams } from '@xyo-network/core';
+import { Payload, ModuleError, Query } from '@xyo-network/payload-model';
+import { AccountInstance } from '@xyo-network/account-model';
+import { Logger } from '@xyo-network/logger';
+import * as _xyo_network_object_identity from '@xyo-network/object-identity';
+import { ObjectTypeCheck, ObjectTypeShape, IsObjectFactory } from '@xyo-network/object-identity';
+import { Promisable } from '@xyo-network/promise';
+import { EventArgs, EventData, EventFunctions } from '@xyo-network/module-events';
+import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import { WalletInstance } from '@xyo-network/wallet-model';
+import { ModuleManifestPayload } from '@xyo-network/manifest-model';
+
+type ModuleConfigSchema = 'network.xyo.module.config';
+declare const ModuleConfigSchema: ModuleConfigSchema;
+type AddressString = string;
+type CosigningAddressSet = string[];
+type SchemaString = string;
+type NameOrAddress = string;
+interface IndividualArchivistConfig {
+    readonly commit?: NameOrAddress;
+    readonly read?: NameOrAddress;
+    readonly write?: NameOrAddress;
+}
+type ArchivistModuleConfig = NameOrAddress | IndividualArchivistConfig;
+type ModuleConfigBase<TConfig extends Payload | undefined = undefined> = Payload<WithAdditional<{
+    /** @field The path to use when creating the account */
+    accountDerivationPath?: string;
+    /** @field The name/address of the Archivist to use for this module */
+    readonly archivist?: ArchivistModuleConfig;
+    /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */
+    readonly name?: string;
+    /** @field paging settings for queries */
+    readonly paging?: Record<string, {
+        size?: number;
+    }>;
+    /** @field The config schema for the module */
+    readonly schema: TConfig extends Payload ? TConfig['schema'] : ModuleConfigSchema;
+    /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority. */
+    readonly security?: {
+        /** @field Will the module process queries that have unsigned BoundWitness in query tuples */
+        readonly allowAnonymous?: boolean;
+        /** @field If schema in record, then only these address sets can access query */
+        readonly allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>;
+        /** @field If schema in record, then anyone except these addresses can access query */
+        readonly disallowed?: Record<SchemaString, AddressString[]>;
+    };
+    /** @field sign every query */
+    readonly sign?: boolean;
+    /** @field Store the queries made to the module in an archivist if possible */
+    readonly storeQueries?: boolean;
+    /** @field add a timestamp payload to every query  */
+    readonly timestamp?: boolean;
+}, Omit<TConfig, 'schema'>>>;
+type ModuleConfig<TConfig extends Payload | undefined = undefined> = ModuleConfigBase<TConfig>;
+type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & {
+    schema: string;
+} = Omit<ModuleConfig, 'schema'> & {
+    schema: string;
+}> = ModuleConfig<WithAdditional<Omit<TConfig, 'schema'>, {
+    schema: string;
+}>>;
+type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {
+    schema?: TConfig['schema'];
+};
+type AnyModuleConfig = AnyConfigSchema<ModuleConfig>;
+
+type ModuleEventArgs<TModule extends object = object, TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs ? {
+    module: TModule;
+} & TArgs : {
+    module: TModule;
+};
+
+type ModuleBusyEventArgs<TModule extends object = object> = ModuleEventArgs<TModule, {
+    busy: boolean;
+}>;
+interface ModuleBusyEventData<TModule extends object = object> extends EventData {
+    moduleBusy: ModuleBusyEventArgs<TModule>;
+}
+
+type ModuleErrorEventArgs<TModule extends object = object> = ModuleEventArgs<TModule, {
+    error: Error;
+}>;
+interface ModuleErrorEventData<TModule extends object = object> extends EventData {
+    moduleError: ModuleErrorEventArgs<TModule>;
+}
+
+type ModuleQueryResult = [BoundWitness, Payload[], ModuleError[]];
+
+type ModuleQueriedEventArgs<TModule extends object = object> = ModuleEventArgs<TModule, {
+    payloads?: Payload[];
+    query: QueryBoundWitness;
+    result: ModuleQueryResult;
+}>;
+interface ModuleQueriedEventData<TModule extends object = object> extends EventData {
+    moduleQueried: ModuleQueriedEventArgs<TModule>;
+}
+
+interface ModuleEventData<TModule extends object = object> extends ModuleQueriedEventData<TModule>, ModuleBusyEventData<TModule>, ModuleErrorEventData<TModule> {
+}
+
+type BasicModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TAdditionalParams extends AnyObject | undefined = undefined> = WithAdditional<BaseParams<{
+    account?: AccountInstance | 'random';
+    config: TConfig;
+    ephemeralQueryAccountEnabled?: boolean;
+    wallet?: WalletInstance;
+}>, TAdditionalParams>;
+type ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = ModuleConfig, TAdditionalParams extends AnyObject | undefined = undefined> = BasicModuleParams<TConfig, TAdditionalParams>;
+
+type ModuleFields<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
+    address: string;
+    config: TParams['config'];
+    params: TParams;
+    previousHash: () => Promisable<string | undefined>;
+    queries: string[];
+    query: <T extends QueryBoundWitness = QueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConf) => Promisable<ModuleQueryResult>;
+    queryable: <T extends QueryBoundWitness = QueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConf) => Promisable<boolean>;
+    start?: () => Promisable<boolean>;
+    stop?: () => Promisable<boolean>;
+};
+
+type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>, TEventData extends ModuleEventData<object> = ModuleEventData<object>> = ModuleFields<TParams> & EventFunctions<TEventData>;
+
+declare const asModule: {
+    (obj: any, config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): Module | undefined;
+    (obj: any, assert: string | (() => string), config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): Module;
+};
+
+declare const asModuleObject: {
+    (obj: any, config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): Module | undefined;
+    (obj: any, assert: string | (() => string), config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): Module;
+};
+
+declare const requiredModuleQueries: string[];
+declare const isModule: ObjectTypeCheck<Module>;
+
+type ModuleTypeCheck<T extends Module = Module> = ObjectTypeCheck<T>;
+declare class IsModuleFactory<T extends Module = Module> {
+    create(expectedQueries?: string[], additionalChecks?: ObjectTypeCheck[]): ModuleTypeCheck<T>;
+}
+
+declare const requiredModuleFunctions: ObjectTypeShape;
+declare const isModuleObject: ObjectTypeCheck<Module>;
+
+interface ModuleDescription {
+    address: string;
+    children?: string[];
+    name?: string;
+    queries: string[];
+}
+
+declare const ModuleDescriptionSchema = "network.xyo.module.description";
+type ModuleDescriptionSchema = typeof ModuleDescriptionSchema;
+type ModuleDescriptionPayload = Payload<ModuleDescription, ModuleDescriptionSchema>;
+
+type ModuleDescribeQuerySchema = 'network.xyo.query.module.describe';
+declare const ModuleDescribeQuerySchema: ModuleDescribeQuerySchema;
+type ModuleDescribeQuery = Query<{
+    schema: ModuleDescribeQuerySchema;
+}>;
+
+type ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover';
+declare const ModuleDiscoverQuerySchema: ModuleDiscoverQuerySchema;
+type ModuleDiscoverQuery = Query<{
+    schema: ModuleDiscoverQuerySchema;
+}>;
+
+type ModuleManifestQuerySchema = 'network.xyo.query.module.manifest';
+declare const ModuleManifestQuerySchema: ModuleManifestQuerySchema;
+type ModuleManifestQuery = Query<{
+    schema: ModuleManifestQuerySchema;
+}>;
+
+declare const AddressPreviousHashSchema: string;
+type AddressPreviousHashSchema = typeof AddressPreviousHashSchema;
+type AddressPreviousHashPayload = Payload<{
+    address: string;
+    previousHash?: string;
+    schema: AddressPreviousHashSchema;
+}>;
+
+type ModuleAddressQuerySchema = 'network.xyo.query.module.address';
+declare const ModuleAddressQuerySchema: ModuleAddressQuerySchema;
+type ModuleAddressQuery = Query<{
+    schema: ModuleAddressQuerySchema;
+}>;
+
+type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe';
+declare const ModuleSubscribeQuerySchema: ModuleSubscribeQuerySchema;
+interface ModuleSubscribeFilter {
+    /** @field if specified, at least one of the schemas must be present in the boundwtness to generate a notification */
+    schema?: string[];
+}
+type ModuleSubscribeQuery = Query<{
+    /** @field The address that will receive notifications */
+    address: string;
+    /** @field A subscribe with a null for filter is an unsubscribe */
+    filter?: ModuleSubscribeFilter | null;
+    /** @field The maximum events queued per send [may increase frequency] */
+    maxQueue?: number;
+    schema: ModuleSubscribeQuerySchema;
+}>;
+
+type ModuleQueryBase = ModuleDiscoverQuery | ModuleAddressQuery | ModuleSubscribeQuery | ModuleDescribeQuery | ModuleManifestQuery;
+type ModuleQuery<T extends Query | void = void> = T extends Query ? ModuleQueryBase | T : ModuleQueryBase;
+
+type ModuleQueryFunctions = {
+    describe: () => Promise<ModuleDescription>;
+    discover: () => Promisable<Payload[]>;
+    manifest: (ignoreAddresses?: string[]) => Promisable<ModuleManifestPayload>;
+    moduleAddress: () => Promisable<AddressPreviousHashPayload[]>;
+};
+
+interface ResolveFunctions {
+    resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter<T>, options?: ModuleFilterOptions<T>): Promisable<T[]>;
+    resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: string, options?: ModuleFilterOptions<T>): Promisable<T | undefined>;
+    resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddressOrFilter?: ModuleFilter<T> | string, options?: ModuleFilterOptions<T>): Promisable<T | T[] | undefined>;
+}
+interface ModuleResolver extends ResolveFunctions {
+    addResolver: (resolver: ModuleResolver) => this;
+    isModuleResolver: boolean;
+    removeResolver: (resolver: ModuleResolver) => this;
+}
+type ModuleInstance<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>, TEventData extends ModuleEventData = ModuleEventData> = Module<TParams, TEventData> & ResolveFunctions & ModuleQueryFunctions & {
+    readonly downResolver: Omit<ModuleResolver, 'resolve'>;
+    readonly upResolver: Omit<ModuleResolver, 'resolve'>;
+};
+type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = ObjectTypeCheck<T>;
+declare class IsInstanceFactory<T extends ModuleInstance = ModuleInstance> extends IsObjectFactory<T> {
+}
+interface ModuleFilterOptions<T extends ModuleInstance = ModuleInstance> {
+    direction?: 'up' | 'down' | 'all';
+    identity?: InstanceTypeCheck<T>;
+    maxDepth?: number;
+    visibility?: 'public' | 'private' | 'all';
+}
+interface AddressModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
+    address: string[];
+}
+interface NameModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
+    name: string[];
+}
+interface QueryModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
+    query: string[][];
+}
+type AnyModuleFilter<T extends ModuleInstance = ModuleInstance> = Partial<AddressModuleFilter<T>> & Partial<NameModuleFilter<T>> & Partial<QueryModuleFilter<T>>;
+type ModuleFilter<T extends ModuleInstance = ModuleInstance> = ModuleFilterOptions<T> | AddressModuleFilter<T> | NameModuleFilter<T> | QueryModuleFilter<T>;
+
+declare const asModuleInstance: {
+    (obj: any, config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): ModuleInstance | undefined;
+    (obj: any, assert: string | (() => string), config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): ModuleInstance;
+};
+
+declare const requiredModuleInstanceFunctions: ObjectTypeShape;
+declare const isModuleInstance: ObjectTypeCheck<ModuleInstance>;
+
+interface ModuleRepository extends ModuleResolver {
+    add(module: Module): this;
+    add(module: Module[]): this;
+    add(module: Module | Module[]): this;
+    remove(address: string | string[]): this;
+}
+
+interface CreatableModule<T extends ModuleInstance = ModuleInstance> {
+    configSchema: string;
+    configSchemas: string[];
+    defaultLogger?: Logger;
+    new (privateConstructorKey: string, params: T['params'], account: AccountInstance): T;
+    _noOverride(functionName: string): void;
+    create<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): Promise<T>;
+    factory<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): CreatableModuleFactory<T>;
+}
+type CreatableModuleFactory<T extends ModuleInstance = ModuleInstance> = Omit<Omit<CreatableModule<T>, 'new'>, 'create'> & {
+    create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: T['params']): Promise<T>;
+};
+/**
+ * Class annotation to be used to decorate Modules which support
+ * an asynchronous creation pattern
+ * @returns The decorated Module requiring it implement the members
+ * of the CreatableModule as statics properties/methods
+ */
+declare function creatableModule<TModule extends ModuleInstance = ModuleInstance>(): <U extends CreatableModule<TModule>>(constructor: U) => void;
+
+interface CreatableModuleDictionary {
+    [key: string]: CreatableModuleFactory;
+}
+
+/**
+ * Used to filter duplicates from an array of modules
+ * @example: modulesArray.filter(duplicateModules)
+ * @param value Current Module
+ * @param index Current Module's index
+ * @param array Module Array
+ * @returns True if the Module's address is the first occurrence of
+ * that address in the array, false otherwise
+ */
+declare const duplicateModules: (value: Module, index: number, array: Module[]) => value is Module;
+
+declare const serializable: (field: unknown, depth?: number) => boolean | null;
+declare const serializableField: (field: unknown) => boolean;
+
+declare class ModuleFactory<TModule extends ModuleInstance> implements CreatableModuleFactory<TModule> {
+    configSchemas: CreatableModuleFactory<TModule>['configSchemas'];
+    creatableModule: CreatableModule<TModule>;
+    defaultLogger?: Logger | undefined;
+    defaultParams?: Omit<TModule['params'], 'config'> & {
+        config?: TModule['params']['config'];
+    };
+    constructor(creatableModule: CreatableModule<TModule>, params?: Omit<TModule['params'], 'config'> & {
+        config?: TModule['params']['config'];
+    });
+    get configSchema(): string;
+    static withParams<T extends ModuleInstance>(creatableModule: CreatableModule<T>, params?: Omit<T['params'], 'config'> & {
+        config?: T['params']['config'];
+    }): ModuleFactory<T>;
+    _getRootFunction(funcName: string): any;
+    _noOverride(functionName: string): void;
+    create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: TModule['params'] | undefined): Promise<T>;
+    factory<T extends ModuleInstance>(this: CreatableModule<T>, _params?: T['params'] | undefined): CreatableModuleFactory<T>;
+}
+
+type ModuleQueryHandlerResult = Payload[];
+
+declare const WithFactory: {
+    create: <T extends object>(typeCheck: ObjectTypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
+};
+declare const withModule: <R>(module: any, closure: (module: Module) => R) => R | undefined;
+declare const withModuleInstance: <R>(module: any, closure: (module: ModuleInstance) => R) => R | undefined;
+
+export { AddressModuleFilter, AddressPreviousHashPayload, AddressPreviousHashSchema, AddressString, AnyConfigSchema, AnyModuleConfig, AnyModuleFilter, ArchivistModuleConfig, BasicModuleParams, CosigningAddressSet, CreatableModule, CreatableModuleDictionary, CreatableModuleFactory, IndividualArchivistConfig, InstanceTypeCheck, IsInstanceFactory, IsModuleFactory, Module, ModuleAddressQuery, ModuleAddressQuerySchema, ModuleBusyEventArgs, ModuleBusyEventData, ModuleConfig, ModuleConfigBase, ModuleConfigSchema, ModuleDescribeQuery, ModuleDescribeQuerySchema, ModuleDescription, ModuleDescriptionPayload, ModuleDescriptionSchema, ModuleDiscoverQuery, ModuleDiscoverQuerySchema, ModuleErrorEventArgs, ModuleErrorEventData, ModuleEventArgs, ModuleEventData, ModuleFactory, ModuleFields, ModuleFilter, ModuleFilterOptions, ModuleInstance, ModuleManifestQuery, ModuleManifestQuerySchema, ModuleParams, ModuleQueriedEventArgs, ModuleQueriedEventData, ModuleQuery, ModuleQueryBase, ModuleQueryFunctions, ModuleQueryHandlerResult, ModuleQueryResult, ModuleRepository, ModuleResolver, ModuleSubscribeFilter, ModuleSubscribeQuery, ModuleSubscribeQuerySchema, ModuleTypeCheck, NameModuleFilter, NameOrAddress, OptionalConfigSchema, QueryModuleFilter, ResolveFunctions, SchemaString, WithFactory, asModule, asModuleInstance, asModuleObject, creatableModule, duplicateModules, isModule, isModuleInstance, isModuleObject, requiredModuleFunctions, requiredModuleInstanceFunctions, requiredModuleQueries, serializable, serializableField, withModule, withModuleInstance };

package/dist/index.d.ts

@@ -0,0 +1,330 @@
+import { WithAdditional, AnyObject, BaseParams } from '@xyo-network/core';
+import { Payload, ModuleError, Query } from '@xyo-network/payload-model';
+import { AccountInstance } from '@xyo-network/account-model';
+import { Logger } from '@xyo-network/logger';
+import * as _xyo_network_object_identity from '@xyo-network/object-identity';
+import { ObjectTypeCheck, ObjectTypeShape, IsObjectFactory } from '@xyo-network/object-identity';
+import { Promisable } from '@xyo-network/promise';
+import { EventArgs, EventData, EventFunctions } from '@xyo-network/module-events';
+import { QueryBoundWitness } from '@xyo-network/boundwitness-builder';
+import { BoundWitness } from '@xyo-network/boundwitness-model';
+import { WalletInstance } from '@xyo-network/wallet-model';
+import { ModuleManifestPayload } from '@xyo-network/manifest-model';
+
+type ModuleConfigSchema = 'network.xyo.module.config';
+declare const ModuleConfigSchema: ModuleConfigSchema;
+type AddressString = string;
+type CosigningAddressSet = string[];
+type SchemaString = string;
+type NameOrAddress = string;
+interface IndividualArchivistConfig {
+    readonly commit?: NameOrAddress;
+    readonly read?: NameOrAddress;
+    readonly write?: NameOrAddress;
+}
+type ArchivistModuleConfig = NameOrAddress | IndividualArchivistConfig;
+type ModuleConfigBase<TConfig extends Payload | undefined = undefined> = Payload<WithAdditional<{
+    /** @field The path to use when creating the account */
+    accountDerivationPath?: string;
+    /** @field The name/address of the Archivist to use for this module */
+    readonly archivist?: ArchivistModuleConfig;
+    /** @field Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node. */
+    readonly name?: string;
+    /** @field paging settings for queries */
+    readonly paging?: Record<string, {
+        size?: number;
+    }>;
+    /** @field The config schema for the module */
+    readonly schema: TConfig extends Payload ? TConfig['schema'] : ModuleConfigSchema;
+    /** @field The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority. */
+    readonly security?: {
+        /** @field Will the module process queries that have unsigned BoundWitness in query tuples */
+        readonly allowAnonymous?: boolean;
+        /** @field If schema in record, then only these address sets can access query */
+        readonly allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>;
+        /** @field If schema in record, then anyone except these addresses can access query */
+        readonly disallowed?: Record<SchemaString, AddressString[]>;
+    };
+    /** @field sign every query */
+    readonly sign?: boolean;
+    /** @field Store the queries made to the module in an archivist if possible */
+    readonly storeQueries?: boolean;
+    /** @field add a timestamp payload to every query  */
+    readonly timestamp?: boolean;
+}, Omit<TConfig, 'schema'>>>;
+type ModuleConfig<TConfig extends Payload | undefined = undefined> = ModuleConfigBase<TConfig>;
+type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & {
+    schema: string;
+} = Omit<ModuleConfig, 'schema'> & {
+    schema: string;
+}> = ModuleConfig<WithAdditional<Omit<TConfig, 'schema'>, {
+    schema: string;
+}>>;
+type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {
+    schema?: TConfig['schema'];
+};
+type AnyModuleConfig = AnyConfigSchema<ModuleConfig>;
+
+type ModuleEventArgs<TModule extends object = object, TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs ? {
+    module: TModule;
+} & TArgs : {
+    module: TModule;
+};
+
+type ModuleBusyEventArgs<TModule extends object = object> = ModuleEventArgs<TModule, {
+    busy: boolean;
+}>;
+interface ModuleBusyEventData<TModule extends object = object> extends EventData {
+    moduleBusy: ModuleBusyEventArgs<TModule>;
+}
+
+type ModuleErrorEventArgs<TModule extends object = object> = ModuleEventArgs<TModule, {
+    error: Error;
+}>;
+interface ModuleErrorEventData<TModule extends object = object> extends EventData {
+    moduleError: ModuleErrorEventArgs<TModule>;
+}
+
+type ModuleQueryResult = [BoundWitness, Payload[], ModuleError[]];
+
+type ModuleQueriedEventArgs<TModule extends object = object> = ModuleEventArgs<TModule, {
+    payloads?: Payload[];
+    query: QueryBoundWitness;
+    result: ModuleQueryResult;
+}>;
+interface ModuleQueriedEventData<TModule extends object = object> extends EventData {
+    moduleQueried: ModuleQueriedEventArgs<TModule>;
+}
+
+interface ModuleEventData<TModule extends object = object> extends ModuleQueriedEventData<TModule>, ModuleBusyEventData<TModule>, ModuleErrorEventData<TModule> {
+}
+
+type BasicModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TAdditionalParams extends AnyObject | undefined = undefined> = WithAdditional<BaseParams<{
+    account?: AccountInstance | 'random';
+    config: TConfig;
+    ephemeralQueryAccountEnabled?: boolean;
+    wallet?: WalletInstance;
+}>, TAdditionalParams>;
+type ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = ModuleConfig, TAdditionalParams extends AnyObject | undefined = undefined> = BasicModuleParams<TConfig, TAdditionalParams>;
+
+type ModuleFields<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
+    address: string;
+    config: TParams['config'];
+    params: TParams;
+    previousHash: () => Promisable<string | undefined>;
+    queries: string[];
+    query: <T extends QueryBoundWitness = QueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConf) => Promisable<ModuleQueryResult>;
+    queryable: <T extends QueryBoundWitness = QueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: Payload[], queryConfig?: TConf) => Promisable<boolean>;
+    start?: () => Promisable<boolean>;
+    stop?: () => Promisable<boolean>;
+};
+
+type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>, TEventData extends ModuleEventData<object> = ModuleEventData<object>> = ModuleFields<TParams> & EventFunctions<TEventData>;
+
+declare const asModule: {
+    (obj: any, config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): Module | undefined;
+    (obj: any, assert: string | (() => string), config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): Module;
+};
+
+declare const asModuleObject: {
+    (obj: any, config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): Module | undefined;
+    (obj: any, assert: string | (() => string), config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): Module;
+};
+
+declare const requiredModuleQueries: string[];
+declare const isModule: ObjectTypeCheck<Module>;
+
+type ModuleTypeCheck<T extends Module = Module> = ObjectTypeCheck<T>;
+declare class IsModuleFactory<T extends Module = Module> {
+    create(expectedQueries?: string[], additionalChecks?: ObjectTypeCheck[]): ModuleTypeCheck<T>;
+}
+
+declare const requiredModuleFunctions: ObjectTypeShape;
+declare const isModuleObject: ObjectTypeCheck<Module>;
+
+interface ModuleDescription {
+    address: string;
+    children?: string[];
+    name?: string;
+    queries: string[];
+}
+
+declare const ModuleDescriptionSchema = "network.xyo.module.description";
+type ModuleDescriptionSchema = typeof ModuleDescriptionSchema;
+type ModuleDescriptionPayload = Payload<ModuleDescription, ModuleDescriptionSchema>;
+
+type ModuleDescribeQuerySchema = 'network.xyo.query.module.describe';
+declare const ModuleDescribeQuerySchema: ModuleDescribeQuerySchema;
+type ModuleDescribeQuery = Query<{
+    schema: ModuleDescribeQuerySchema;
+}>;
+
+type ModuleDiscoverQuerySchema = 'network.xyo.query.module.discover';
+declare const ModuleDiscoverQuerySchema: ModuleDiscoverQuerySchema;
+type ModuleDiscoverQuery = Query<{
+    schema: ModuleDiscoverQuerySchema;
+}>;
+
+type ModuleManifestQuerySchema = 'network.xyo.query.module.manifest';
+declare const ModuleManifestQuerySchema: ModuleManifestQuerySchema;
+type ModuleManifestQuery = Query<{
+    schema: ModuleManifestQuerySchema;
+}>;
+
+declare const AddressPreviousHashSchema: string;
+type AddressPreviousHashSchema = typeof AddressPreviousHashSchema;
+type AddressPreviousHashPayload = Payload<{
+    address: string;
+    previousHash?: string;
+    schema: AddressPreviousHashSchema;
+}>;
+
+type ModuleAddressQuerySchema = 'network.xyo.query.module.address';
+declare const ModuleAddressQuerySchema: ModuleAddressQuerySchema;
+type ModuleAddressQuery = Query<{
+    schema: ModuleAddressQuerySchema;
+}>;
+
+type ModuleSubscribeQuerySchema = 'network.xyo.query.module.subscribe';
+declare const ModuleSubscribeQuerySchema: ModuleSubscribeQuerySchema;
+interface ModuleSubscribeFilter {
+    /** @field if specified, at least one of the schemas must be present in the boundwtness to generate a notification */
+    schema?: string[];
+}
+type ModuleSubscribeQuery = Query<{
+    /** @field The address that will receive notifications */
+    address: string;
+    /** @field A subscribe with a null for filter is an unsubscribe */
+    filter?: ModuleSubscribeFilter | null;
+    /** @field The maximum events queued per send [may increase frequency] */
+    maxQueue?: number;
+    schema: ModuleSubscribeQuerySchema;
+}>;
+
+type ModuleQueryBase = ModuleDiscoverQuery | ModuleAddressQuery | ModuleSubscribeQuery | ModuleDescribeQuery | ModuleManifestQuery;
+type ModuleQuery<T extends Query | void = void> = T extends Query ? ModuleQueryBase | T : ModuleQueryBase;
+
+type ModuleQueryFunctions = {
+    describe: () => Promise<ModuleDescription>;
+    discover: () => Promisable<Payload[]>;
+    manifest: (ignoreAddresses?: string[]) => Promisable<ModuleManifestPayload>;
+    moduleAddress: () => Promisable<AddressPreviousHashPayload[]>;
+};
+
+interface ResolveFunctions {
+    resolve<T extends ModuleInstance = ModuleInstance>(filter?: ModuleFilter<T>, options?: ModuleFilterOptions<T>): Promisable<T[]>;
+    resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddress: string, options?: ModuleFilterOptions<T>): Promisable<T | undefined>;
+    resolve<T extends ModuleInstance = ModuleInstance>(nameOrAddressOrFilter?: ModuleFilter<T> | string, options?: ModuleFilterOptions<T>): Promisable<T | T[] | undefined>;
+}
+interface ModuleResolver extends ResolveFunctions {
+    addResolver: (resolver: ModuleResolver) => this;
+    isModuleResolver: boolean;
+    removeResolver: (resolver: ModuleResolver) => this;
+}
+type ModuleInstance<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>, TEventData extends ModuleEventData = ModuleEventData> = Module<TParams, TEventData> & ResolveFunctions & ModuleQueryFunctions & {
+    readonly downResolver: Omit<ModuleResolver, 'resolve'>;
+    readonly upResolver: Omit<ModuleResolver, 'resolve'>;
+};
+type InstanceTypeCheck<T extends ModuleInstance = ModuleInstance> = ObjectTypeCheck<T>;
+declare class IsInstanceFactory<T extends ModuleInstance = ModuleInstance> extends IsObjectFactory<T> {
+}
+interface ModuleFilterOptions<T extends ModuleInstance = ModuleInstance> {
+    direction?: 'up' | 'down' | 'all';
+    identity?: InstanceTypeCheck<T>;
+    maxDepth?: number;
+    visibility?: 'public' | 'private' | 'all';
+}
+interface AddressModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
+    address: string[];
+}
+interface NameModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
+    name: string[];
+}
+interface QueryModuleFilter<T extends ModuleInstance = ModuleInstance> extends ModuleFilterOptions<T> {
+    query: string[][];
+}
+type AnyModuleFilter<T extends ModuleInstance = ModuleInstance> = Partial<AddressModuleFilter<T>> & Partial<NameModuleFilter<T>> & Partial<QueryModuleFilter<T>>;
+type ModuleFilter<T extends ModuleInstance = ModuleInstance> = ModuleFilterOptions<T> | AddressModuleFilter<T> | NameModuleFilter<T> | QueryModuleFilter<T>;
+
+declare const asModuleInstance: {
+    (obj: any, config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): ModuleInstance | undefined;
+    (obj: any, assert: string | (() => string), config?: _xyo_network_object_identity.ObjectTypeConfig | undefined): ModuleInstance;
+};
+
+declare const requiredModuleInstanceFunctions: ObjectTypeShape;
+declare const isModuleInstance: ObjectTypeCheck<ModuleInstance>;
+
+interface ModuleRepository extends ModuleResolver {
+    add(module: Module): this;
+    add(module: Module[]): this;
+    add(module: Module | Module[]): this;
+    remove(address: string | string[]): this;
+}
+
+interface CreatableModule<T extends ModuleInstance = ModuleInstance> {
+    configSchema: string;
+    configSchemas: string[];
+    defaultLogger?: Logger;
+    new (privateConstructorKey: string, params: T['params'], account: AccountInstance): T;
+    _noOverride(functionName: string): void;
+    create<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): Promise<T>;
+    factory<T extends ModuleInstance>(this: CreatableModule<T>, params?: T['params']): CreatableModuleFactory<T>;
+}
+type CreatableModuleFactory<T extends ModuleInstance = ModuleInstance> = Omit<Omit<CreatableModule<T>, 'new'>, 'create'> & {
+    create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: T['params']): Promise<T>;
+};
+/**
+ * Class annotation to be used to decorate Modules which support
+ * an asynchronous creation pattern
+ * @returns The decorated Module requiring it implement the members
+ * of the CreatableModule as statics properties/methods
+ */
+declare function creatableModule<TModule extends ModuleInstance = ModuleInstance>(): <U extends CreatableModule<TModule>>(constructor: U) => void;
+
+interface CreatableModuleDictionary {
+    [key: string]: CreatableModuleFactory;
+}
+
+/**
+ * Used to filter duplicates from an array of modules
+ * @example: modulesArray.filter(duplicateModules)
+ * @param value Current Module
+ * @param index Current Module's index
+ * @param array Module Array
+ * @returns True if the Module's address is the first occurrence of
+ * that address in the array, false otherwise
+ */
+declare const duplicateModules: (value: Module, index: number, array: Module[]) => value is Module;
+
+declare const serializable: (field: unknown, depth?: number) => boolean | null;
+declare const serializableField: (field: unknown) => boolean;
+
+declare class ModuleFactory<TModule extends ModuleInstance> implements CreatableModuleFactory<TModule> {
+    configSchemas: CreatableModuleFactory<TModule>['configSchemas'];
+    creatableModule: CreatableModule<TModule>;
+    defaultLogger?: Logger | undefined;
+    defaultParams?: Omit<TModule['params'], 'config'> & {
+        config?: TModule['params']['config'];
+    };
+    constructor(creatableModule: CreatableModule<TModule>, params?: Omit<TModule['params'], 'config'> & {
+        config?: TModule['params']['config'];
+    });
+    get configSchema(): string;
+    static withParams<T extends ModuleInstance>(creatableModule: CreatableModule<T>, params?: Omit<T['params'], 'config'> & {
+        config?: T['params']['config'];
+    }): ModuleFactory<T>;
+    _getRootFunction(funcName: string): any;
+    _noOverride(functionName: string): void;
+    create<T extends ModuleInstance>(this: CreatableModuleFactory<T>, params?: TModule['params'] | undefined): Promise<T>;
+    factory<T extends ModuleInstance>(this: CreatableModule<T>, _params?: T['params'] | undefined): CreatableModuleFactory<T>;
+}
+
+type ModuleQueryHandlerResult = Payload[];
+
+declare const WithFactory: {
+    create: <T extends object>(typeCheck: ObjectTypeCheck<T>) => <R>(module: any, closure: (module: T) => R) => R | undefined;
+};
+declare const withModule: <R>(module: any, closure: (module: Module) => R) => R | undefined;
+declare const withModuleInstance: <R>(module: any, closure: (module: ModuleInstance) => R) => R | undefined;
+
+export { AddressModuleFilter, AddressPreviousHashPayload, AddressPreviousHashSchema, AddressString, AnyConfigSchema, AnyModuleConfig, AnyModuleFilter, ArchivistModuleConfig, BasicModuleParams, CosigningAddressSet, CreatableModule, CreatableModuleDictionary, CreatableModuleFactory, IndividualArchivistConfig, InstanceTypeCheck, IsInstanceFactory, IsModuleFactory, Module, ModuleAddressQuery, ModuleAddressQuerySchema, ModuleBusyEventArgs, ModuleBusyEventData, ModuleConfig, ModuleConfigBase, ModuleConfigSchema, ModuleDescribeQuery, ModuleDescribeQuerySchema, ModuleDescription, ModuleDescriptionPayload, ModuleDescriptionSchema, ModuleDiscoverQuery, ModuleDiscoverQuerySchema, ModuleErrorEventArgs, ModuleErrorEventData, ModuleEventArgs, ModuleEventData, ModuleFactory, ModuleFields, ModuleFilter, ModuleFilterOptions, ModuleInstance, ModuleManifestQuery, ModuleManifestQuerySchema, ModuleParams, ModuleQueriedEventArgs, ModuleQueriedEventData, ModuleQuery, ModuleQueryBase, ModuleQueryFunctions, ModuleQueryHandlerResult, ModuleQueryResult, ModuleRepository, ModuleResolver, ModuleSubscribeFilter, ModuleSubscribeQuery, ModuleSubscribeQuerySchema, ModuleTypeCheck, NameModuleFilter, NameOrAddress, OptionalConfigSchema, QueryModuleFilter, ResolveFunctions, SchemaString, WithFactory, asModule, asModuleInstance, asModuleObject, creatableModule, duplicateModules, isModule, isModuleInstance, isModuleObject, requiredModuleFunctions, requiredModuleInstanceFunctions, requiredModuleQueries, serializable, serializableField, withModule, withModuleInstance };