@xyo-network/module-model 2.51.8 → 2.51.10

package/dist/esm/CreatableModule.js

@@ -0,0 +1,12 @@
+/**
+ * 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
+ */
+export function creatableModule() {
+    return (constructor) => {
+        constructor;
+    };
+}
+//# sourceMappingURL=CreatableModule.js.map

package/dist/esm/CreatableModule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreatableModule.js","sourceRoot":"","sources":["../../src/CreatableModule.ts"],"names":[],"mappings":"AAWA;;;;;GAKG;AACH,MAAM,UAAU,eAAe;IAC7B,OAAO,CAAqC,WAAc,EAAE,EAAE;QAC5D,WAAW,CAAA;IACb,CAAC,CAAA;AACH,CAAC"}

package/dist/esm/{model/Module.js.map → Module.js.map}

@@ -1 +1 @@
-{"version":3,"file":"Module.js","sourceRoot":"","sources":["../../../src/model/Module.ts"],"names":[],"mappings":""}
+{"version":3,"file":"Module.js","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":""}

package/dist/esm/ModuleDescription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleDescription.js","sourceRoot":"","sources":["../../src/ModuleDescription.ts"],"names":[],"mappings":""}

package/dist/esm/ModuleEventArgs.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ModuleEventArgs.js.map

package/dist/esm/ModuleEventArgs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleEventArgs.js","sourceRoot":"","sources":["../../src/ModuleEventArgs.ts"],"names":[],"mappings":""}

package/dist/esm/ModuleParams.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ModuleParams.js.map

package/dist/esm/ModuleParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleParams.js","sourceRoot":"","sources":["../../src/ModuleParams.ts"],"names":[],"mappings":""}

package/dist/esm/ModuleQueried.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ModuleQueried.js.map

package/dist/esm/ModuleQueried.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleQueried.js","sourceRoot":"","sources":["../../src/ModuleQueried.ts"],"names":[],"mappings":""}

package/dist/esm/ModuleRepository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleRepository.js","sourceRoot":"","sources":["../../src/ModuleRepository.ts"],"names":[],"mappings":""}

package/dist/esm/index.js

@@ -1,9 +1,13 @@
 export * from './Config';
-export * from './Events';
-export * from './model';
+export * from './CreatableModule';
+export * from './Module';
+export * from './ModuleDescription';
+export * from './ModuleEventArgs';
 export * from './ModuleFilter';
+export * from './ModuleParams';
+export * from './ModuleQueried';
 export * from './ModuleQueryResult';
-export * from './PartialConfig';
+export * from './ModuleRepository';
 export * from './Queries';
 export * from './Query';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}

package/dist/types/Config.d.ts

@@ -1,18 +1,19 @@
-import { AnyObject } from '@xyo-network/core';
+import { WithAdditional } from '@xyo-network/core';
 import { XyoPayload } from '@xyo-network/payload-model';
 export type ModuleConfigSchema = 'network.xyo.module.config';
 export declare const ModuleConfigSchema: ModuleConfigSchema;
 export type AddressString = string;
 export type CosigningAddressSet = string[];
 export type SchemaString = string;
-export type ModuleConfigBase<T extends AnyObject = AnyObject> = XyoPayload<{
+export type ModuleConfigBase<TConfig extends XyoPayload | undefined = undefined> = XyoPayload<WithAdditional<{
     name?: string;
+    schema: TConfig extends XyoPayload ? TConfig['schema'] : ModuleConfigSchema;
     security?: {
         allowAnonymous?: boolean;
         allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>;
         disallowed?: Record<SchemaString, AddressString[]>;
     };
     storeQueries?: boolean;
-} & T>;
-export type ModuleConfig<TConfig extends XyoPayload = XyoPayload> = ModuleConfigBase<TConfig>;
+}, Omit<TConfig, 'schema'>>>;
+export type ModuleConfig<TConfig extends XyoPayload | undefined = undefined> = ModuleConfigBase<TConfig>;
 //# sourceMappingURL=Config.d.ts.map

package/dist/types/Config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAEvD,MAAM,MAAM,kBAAkB,GAAG,2BAA2B,CAAA;AAC5D,eAAO,MAAM,kBAAkB,EAAE,kBAAgD,CAAA;AAEjF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAA;AAC1C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,SAAS,GAAG,SAAS,IAAI,UAAU,CACxE;IAEE,IAAI,CAAC,EAAE,MAAM,CAAA;IAGb,QAAQ,CAAC,EAAE;QAET,cAAc,CAAC,EAAE,OAAO,CAAA;QAGxB,OAAO,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,aAAa,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAA;QAGvE,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,CAAA;KACnD,CAAA;IAGD,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,GAAG,CAAC,CACN,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,UAAU,GAAG,UAAU,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAA"}
+{"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAEvD,MAAM,MAAM,kBAAkB,GAAG,2BAA2B,CAAA;AAC5D,eAAO,MAAM,kBAAkB,EAAE,kBAAgD,CAAA;AAEjF,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAClC,MAAM,MAAM,mBAAmB,GAAG,MAAM,EAAE,CAAA;AAC1C,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AAEjC,MAAM,MAAM,gBAAgB,CAAC,OAAO,SAAS,UAAU,GAAG,SAAS,GAAG,SAAS,IAAI,UAAU,CAC3F,cAAc,CACZ;IAEE,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,MAAM,EAAE,OAAO,SAAS,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC,GAAG,kBAAkB,CAAA;IAG3E,QAAQ,CAAC,EAAE;QAET,cAAc,CAAC,EAAE,OAAO,CAAA;QAGxB,OAAO,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,CAAC,aAAa,GAAG,mBAAmB,CAAC,EAAE,CAAC,CAAA;QAGvE,UAAU,CAAC,EAAE,MAAM,CAAC,YAAY,EAAE,aAAa,EAAE,CAAC,CAAA;KACnD,CAAA;IAGD,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB,EACD,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CACxB,CACF,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,OAAO,SAAS,UAAU,GAAG,SAAS,GAAG,SAAS,IAAI,gBAAgB,CAAC,OAAO,CAAC,CAAA"}

package/dist/types/CreatableModule.d.ts

@@ -0,0 +1,16 @@
+import { Logger } from '@xyo-network/core';
+import { Module } from './Module';
+export interface CreatableModule<T extends Module = Module> {
+    configSchema: string;
+    defaultLogger?: Logger;
+    new (params: T['params']): T;
+    create<T extends Module>(this: CreatableModule<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
+ */
+export declare function creatableModule<TModule extends Module = Module>(): <U extends CreatableModule<TModule>>(constructor: U) => void;
+//# sourceMappingURL=CreatableModule.d.ts.map

package/dist/types/CreatableModule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreatableModule.d.ts","sourceRoot":"","sources":["../../src/CreatableModule.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAE1C,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,MAAM,WAAW,eAAe,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IACxD,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,KAAK,MAAM,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;IAC5B,MAAM,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;CACrF;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,SAAS,MAAM,GAAG,MAAM,kEAI9D"}

package/dist/types/{model/Module.d.ts → Module.d.ts}

@@ -1,26 +1,26 @@
+import { EventFunctions } from '@xyo-network/module-events';
 import { XyoPayload } from '@xyo-network/payload-model';
 import { Promisable } from '@xyo-network/promise';
-import { ModuleConfig } from '../Config';
-import { ModuleEventEmitter, ModuleQueriedEventEmitter } from '../Events';
-import { ModuleFilter } from '../ModuleFilter';
-import { ModuleQueryResult } from '../ModuleQueryResult';
-import { XyoQueryBoundWitness } from '../Query';
+import { ModuleConfig } from './Config';
+import { ModuleFilter } from './ModuleFilter';
+import { AnyConfigSchema, ModuleParams } from './ModuleParams';
+import { ModuleQueryResult } from './ModuleQueryResult';
+import { XyoQueryBoundWitness } from './Query';
 export interface ModuleResolver {
     addResolver: (resolver: ModuleResolver) => this;
     isModuleResolver: boolean;
     removeResolver: (resolver: ModuleResolver) => this;
     resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>;
 }
-export type EventModule<TConfig extends ModuleConfig = ModuleConfig, TModuleEventEmitter extends ModuleEventEmitter | undefined = undefined> = {
-    on: TModuleEventEmitter extends ModuleEventEmitter ? ModuleQueriedEventEmitter['on'] | TModuleEventEmitter['on'] : ModuleQueriedEventEmitter['on'];
-} & Module<TConfig>;
-export type Module<TConfig extends ModuleConfig = ModuleConfig> = {
+export type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
     address: string;
-    config: TConfig;
+    config: TParams['config'];
     readonly downResolver: ModuleResolver;
+    params: TParams;
     queries: string[];
     query: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: XyoPayload[], queryConfig?: TConf) => Promisable<ModuleQueryResult>;
     queryable: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(query: T, payloads?: XyoPayload[], queryConfig?: TConf) => Promisable<boolean>;
+    start?: () => Promisable<void>;
     readonly upResolver: ModuleResolver;
-};
+} & EventFunctions<TParams['eventData']>;
 //# sourceMappingURL=Module.d.ts.map

package/dist/types/Module.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAC3D,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AACvD,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAA;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAE9C,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAC/C,gBAAgB,EAAE,OAAO,CAAA;IACzB,cAAc,EAAE,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAA;IAClD,OAAO,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,UAAU,CAAC,CAAC,EAAE,CAAC,CAAA;CAC3E;AAED,MAAM,MAAM,MAAM,CAAC,OAAO,SAAS,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,GAAG,YAAY,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC,IAAI;IAC9H,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;IAGzB,QAAQ,CAAC,YAAY,EAAE,cAAc,CAAA;IAErC,MAAM,EAAE,OAAO,CAAA;IAEf,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,KAAK,EAAE,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EACtG,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,UAAU,EAAE,EACvB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,iBAAiB,CAAC,CAAA;IAClC,SAAS,EAAE,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,EAAE,KAAK,SAAS,YAAY,GAAG,YAAY,EAC1G,KAAK,EAAE,CAAC,EACR,QAAQ,CAAC,EAAE,UAAU,EAAE,EACvB,WAAW,CAAC,EAAE,KAAK,KAChB,UAAU,CAAC,OAAO,CAAC,CAAA;IAExB,KAAK,CAAC,EAAE,MAAM,UAAU,CAAC,IAAI,CAAC,CAAA;IAI9B,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAA;CACpC,GAAG,cAAc,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAA"}

package/dist/types/ModuleDescription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleDescription.d.ts","sourceRoot":"","sources":["../../src/ModuleDescription.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,EAAE,CAAA;CAClB"}

package/dist/types/ModuleEventArgs.d.ts

@@ -0,0 +1,8 @@
+import { EventArgs } from '@xyo-network/module-events';
+import { Module } from './Module';
+export type ModuleEventArgs<TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs ? {
+    module: Module;
+} & TArgs : {
+    module: Module;
+};
+//# sourceMappingURL=ModuleEventArgs.d.ts.map

package/dist/types/ModuleEventArgs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleEventArgs.d.ts","sourceRoot":"","sources":["../../src/ModuleEventArgs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAEtD,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAEjC,MAAM,MAAM,eAAe,CAAC,KAAK,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IAAI,KAAK,SAAS,SAAS,GAClG;IACE,MAAM,EAAE,MAAM,CAAA;CACf,GAAG,KAAK,GACT;IACE,MAAM,EAAE,MAAM,CAAA;CACf,CAAA"}

package/dist/types/ModuleParams.d.ts

@@ -0,0 +1,25 @@
+import { AccountInstance } from '@xyo-network/account-model';
+import { AnyObject, BaseParams, WithAdditional } from '@xyo-network/core';
+import { EventData, EventDataParams } from '@xyo-network/module-events';
+import { WalletInstance } from '@xyo-network/wallet-model';
+import { ModuleConfig } from './Config';
+export type BasicModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TEventData extends EventData | undefined = undefined, TAdditionalParams extends AnyObject | undefined = undefined> = WithAdditional<EventDataParams<TEventData, BaseParams<{
+    config: TConfig;
+}>>, TAdditionalParams>;
+export type AccountModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TEventData extends EventData | undefined = undefined, TAdditionalParams extends AnyObject | undefined = undefined> = BasicModuleParams<TConfig, TEventData, WithAdditional<{
+    account: AccountInstance;
+}, TAdditionalParams>>;
+export type WalletModuleParams<TConfig extends AnyConfigSchema<ModuleConfig>, TEventData extends EventData | undefined = undefined, TAdditionalParams extends AnyObject | undefined = undefined> = BasicModuleParams<TConfig, TEventData, WithAdditional<{
+    accountDerivationPath: string;
+    wallet: WalletInstance;
+}, TAdditionalParams>>;
+export type ModuleParams<TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>, TEventData extends EventData | undefined = undefined, TAdditionalParams extends AnyObject | undefined = undefined> = AccountModuleParams<TConfig, TEventData, TAdditionalParams> | WalletModuleParams<TConfig, TEventData, TAdditionalParams> | BasicModuleParams<TConfig, TEventData, TAdditionalParams>;
+export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & {
+    schema: string;
+}> = ModuleConfig<WithAdditional<Omit<TConfig, 'schema'>, {
+    schema: string;
+}>>;
+export type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & {
+    schema?: TConfig['schema'];
+};
+//# sourceMappingURL=ModuleParams.d.ts.map

package/dist/types/ModuleParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleParams.d.ts","sourceRoot":"","sources":["../../src/ModuleParams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAC5D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAA;AACzE,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAA;AAE1D,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AAEvC,MAAM,MAAM,iBAAiB,CAC3B,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,EAC7C,UAAU,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EACpD,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IACzD,cAAc,CAChB,eAAe,CACb,UAAU,EACV,UAAU,CAAC;IACT,MAAM,EAAE,OAAO,CAAA;CAChB,CAAC,CACH,EACD,iBAAiB,CAClB,CAAA;AAED,MAAM,MAAM,mBAAmB,CAC7B,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,EAC7C,UAAU,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EACpD,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IACzD,iBAAiB,CACnB,OAAO,EACP,UAAU,EACV,cAAc,CACZ;IACE,OAAO,EAAE,eAAe,CAAA;CACzB,EACD,iBAAiB,CAClB,CACF,CAAA;AAED,MAAM,MAAM,kBAAkB,CAC5B,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,EAC7C,UAAU,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EACpD,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IACzD,iBAAiB,CACnB,OAAO,EACP,UAAU,EACV,cAAc,CACZ;IACE,qBAAqB,EAAE,MAAM,CAAA;IAC7B,MAAM,EAAE,cAAc,CAAA;CACvB,EACD,iBAAiB,CAClB,CACF,CAAA;AAED,MAAM,MAAM,YAAY,CACtB,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,GAAG,eAAe,CAAC,YAAY,CAAC,EAC7E,UAAU,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,EACpD,iBAAiB,SAAS,SAAS,GAAG,SAAS,GAAG,SAAS,IAEzD,mBAAmB,CAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,GAC3D,kBAAkB,CAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,GAC1D,iBAAiB,CAAC,OAAO,EAAE,UAAU,EAAE,iBAAiB,CAAC,CAAA;AAE7D,MAAM,MAAM,eAAe,CAAC,OAAO,SAAS,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,IAAI,YAAY,CAC3G,cAAc,CACZ,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,EACvB;IACE,MAAM,EAAE,MAAM,CAAA;CACf,CACF,CACF,CAAA;AAED,MAAM,MAAM,oBAAoB,CAAC,OAAO,SAAS,eAAe,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,GAAG;IAAE,MAAM,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;CAAE,CAAA"}

package/dist/types/ModuleQueried.d.ts

@@ -0,0 +1,14 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness-model';
+import { EventData } from '@xyo-network/module-events';
+import { XyoPayload } from '@xyo-network/payload-model';
+import { ModuleEventArgs } from './ModuleEventArgs';
+import { XyoQueryBoundWitness } from './Query';
+export type ModuleQueriedEventArgs = ModuleEventArgs<{
+    payloads?: XyoPayload[];
+    query: XyoQueryBoundWitness;
+    result: [XyoBoundWitness, XyoPayload[]];
+}>;
+export interface ModuleEventData extends EventData {
+    moduleQueried: ModuleQueriedEventArgs;
+}
+//# sourceMappingURL=ModuleQueried.d.ts.map

package/dist/types/ModuleQueried.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleQueried.d.ts","sourceRoot":"","sources":["../../src/ModuleQueried.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAA;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AACtD,OAAO,EAAE,UAAU,EAAE,MAAM,4BAA4B,CAAA;AAEvD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAA;AAE9C,MAAM,MAAM,sBAAsB,GAAG,eAAe,CAAC;IACnD,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAA;IACvB,KAAK,EAAE,oBAAoB,CAAA;IAC3B,MAAM,EAAE,CAAC,eAAe,EAAE,UAAU,EAAE,CAAC,CAAA;CACxC,CAAC,CAAA;AAEF,MAAM,WAAW,eAAgB,SAAQ,SAAS;IAChD,aAAa,EAAE,sBAAsB,CAAA;CACtC"}

package/dist/types/ModuleRepository.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ModuleRepository.d.ts","sourceRoot":"","sources":["../../src/ModuleRepository.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAEjD,MAAM,WAAW,gBAAiB,SAAQ,cAAc;IACtD,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAC3B,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAEpC,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;CACzC"}

package/dist/types/index.d.ts

@@ -1,9 +1,13 @@
 export * from './Config';
-export * from './Events';
-export * from './model';
+export * from './CreatableModule';
+export * from './Module';
+export * from './ModuleDescription';
+export * from './ModuleEventArgs';
 export * from './ModuleFilter';
+export * from './ModuleParams';
+export * from './ModuleQueried';
 export * from './ModuleQueryResult';
-export * from './PartialConfig';
+export * from './ModuleRepository';
 export * from './Queries';
 export * from './Query';
 //# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,qBAAqB,CAAA;AACnC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,mBAAmB,CAAA;AACjC,cAAc,UAAU,CAAA;AACxB,cAAc,qBAAqB,CAAA;AACnC,cAAc,mBAAmB,CAAA;AACjC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA;AAClC,cAAc,WAAW,CAAA;AACzB,cAAc,SAAS,CAAA"}

package/package.json

@@ -10,10 +10,13 @@
     "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
   },
   "dependencies": {
-    "@xyo-network/boundwitness-model": "^2.51.8",
-    "@xyo-network/core": "^2.51.8",
-    "@xyo-network/payload-model": "^2.51.8",
-    "@xyo-network/promise": "^2.51.8"
+    "@xyo-network/account-model": "^2.51.10",
+    "@xyo-network/boundwitness-model": "^2.51.10",
+    "@xyo-network/core": "^2.51.10",
+    "@xyo-network/module-events": "^2.51.10",
+    "@xyo-network/payload-model": "^2.51.10",
+    "@xyo-network/promise": "^2.51.10",
+    "@xyo-network/wallet-model": "^2.51.10"
   },
   "devDependencies": {
     "@xylabs/ts-scripts-yarn3": "^2.16.1",
@@ -53,5 +56,5 @@
   },
   "sideEffects": false,
   "types": "dist/types/index.d.ts",
-  "version": "2.51.8"
+  "version": "2.51.10"
 }

package/src/Config.ts

@@ -1,4 +1,4 @@
-import { AnyObject } from '@xyo-network/core'
+import { WithAdditional } from '@xyo-network/core'
 import { XyoPayload } from '@xyo-network/payload-model'
 
 export type ModuleConfigSchema = 'network.xyo.module.config'
@@ -8,26 +8,31 @@ export type AddressString = string
 export type CosigningAddressSet = string[]
 export type SchemaString = string
 
-export type ModuleConfigBase<T extends AnyObject = AnyObject> = XyoPayload<
-  {
-    //friendly name of module (not collision resistent)
-    name?: string
+export type ModuleConfigBase<TConfig extends XyoPayload | undefined = undefined> = XyoPayload<
+  WithAdditional<
+    {
+      //friendly name of module (not collision resistent)
+      name?: string
 
-    //if both allowed and disallowed is specified, then disallowed takes priority
-    security?: {
-      //will process queries that have unsigned boundwitness in tuples
-      allowAnonymous?: boolean
+      schema: TConfig extends XyoPayload ? TConfig['schema'] : ModuleConfigSchema
 
-      //if schema in record, then only these address sets can access query
-      allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>
+      //if both allowed and disallowed is specified, then disallowed takes priority
+      security?: {
+        //will process queries that have unsigned boundwitness in tuples
+        allowAnonymous?: boolean
 
-      //if schema in record, then anyone except these addresses can access query
-      disallowed?: Record<SchemaString, AddressString[]>
-    }
+        //if schema in record, then only these address sets can access query
+        allowed?: Record<SchemaString, (AddressString | CosigningAddressSet)[]>
 
-    //store the queries made to the module in an archivist if possible
-    storeQueries?: boolean
-  } & T
+        //if schema in record, then anyone except these addresses can access query
+        disallowed?: Record<SchemaString, AddressString[]>
+      }
+
+      //store the queries made to the module in an archivist if possible
+      storeQueries?: boolean
+    },
+    Omit<TConfig, 'schema'>
+  >
 >
 
-export type ModuleConfig<TConfig extends XyoPayload = XyoPayload> = ModuleConfigBase<TConfig>
+export type ModuleConfig<TConfig extends XyoPayload | undefined = undefined> = ModuleConfigBase<TConfig>

package/src/CreatableModule.ts

@@ -0,0 +1,22 @@
+import { Logger } from '@xyo-network/core'
+
+import { Module } from './Module'
+
+export interface CreatableModule<T extends Module = Module> {
+  configSchema: string
+  defaultLogger?: Logger
+  new (params: T['params']): T
+  create<T extends Module>(this: CreatableModule<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
+ */
+export function creatableModule<TModule extends Module = Module>() {
+  return <U extends CreatableModule<TModule>>(constructor: U) => {
+    constructor
+  }
+}

package/src/{model/Module.ts → Module.ts}

@@ -1,11 +1,12 @@
+import { EventFunctions } from '@xyo-network/module-events'
 import { XyoPayload } from '@xyo-network/payload-model'
 import { Promisable } from '@xyo-network/promise'
 
-import { ModuleConfig } from '../Config'
-import { ModuleEventEmitter, ModuleQueriedEventEmitter } from '../Events'
-import { ModuleFilter } from '../ModuleFilter'
-import { ModuleQueryResult } from '../ModuleQueryResult'
-import { XyoQueryBoundWitness } from '../Query'
+import { ModuleConfig } from './Config'
+import { ModuleFilter } from './ModuleFilter'
+import { AnyConfigSchema, ModuleParams } from './ModuleParams'
+import { ModuleQueryResult } from './ModuleQueryResult'
+import { XyoQueryBoundWitness } from './Query'
 
 export interface ModuleResolver {
   addResolver: (resolver: ModuleResolver) => this
@@ -14,17 +15,15 @@ export interface ModuleResolver {
   resolve<T extends Module = Module>(filter?: ModuleFilter): Promisable<T[]>
 }
 
-export type EventModule<TConfig extends ModuleConfig = ModuleConfig, TModuleEventEmitter extends ModuleEventEmitter | undefined = undefined> = {
-  on: TModuleEventEmitter extends ModuleEventEmitter ? ModuleQueriedEventEmitter['on'] | TModuleEventEmitter['on'] : ModuleQueriedEventEmitter['on']
-} & Module<TConfig>
-
-export type Module<TConfig extends ModuleConfig = ModuleConfig> = {
+export type Module<TParams extends ModuleParams<AnyConfigSchema<ModuleConfig>> = ModuleParams<AnyConfigSchema<ModuleConfig>>> = {
   address: string
-  config: TConfig
+  config: TParams['config']
 
   /* The resolver is a 'down' resolver.  It can resolve the module or any children (if it is a node for example), that are in the module*/
   readonly downResolver: ModuleResolver
 
+  params: TParams
+
   queries: string[]
   query: <T extends XyoQueryBoundWitness = XyoQueryBoundWitness, TConf extends ModuleConfig = ModuleConfig>(
     query: T,
@@ -37,7 +36,9 @@ export type Module<TConfig extends ModuleConfig = ModuleConfig> = {
     queryConfig?: TConf,
   ) => Promisable<boolean>
 
+  start?: () => Promisable<void>
+
   /* The resolver is a 'up' resolver.  It can resolve the parent or any children of the parent*/
   /* This is set by a NodeModule when attaching to the module */
   readonly upResolver: ModuleResolver
-}
+} & EventFunctions<TParams['eventData']>

package/src/ModuleEventArgs.ts

@@ -0,0 +1,11 @@
+import { EventArgs } from '@xyo-network/module-events'
+
+import { Module } from './Module'
+
+export type ModuleEventArgs<TArgs extends EventArgs | undefined = undefined> = TArgs extends EventArgs
+  ? {
+      module: Module
+    } & TArgs
+  : {
+      module: Module
+    }

package/src/ModuleParams.ts

@@ -0,0 +1,71 @@
+import { AccountInstance } from '@xyo-network/account-model'
+import { AnyObject, BaseParams, WithAdditional } from '@xyo-network/core'
+import { EventData, EventDataParams } from '@xyo-network/module-events'
+import { WalletInstance } from '@xyo-network/wallet-model'
+
+import { ModuleConfig } from './Config'
+
+export type BasicModuleParams<
+  TConfig extends AnyConfigSchema<ModuleConfig>,
+  TEventData extends EventData | undefined = undefined,
+  TAdditionalParams extends AnyObject | undefined = undefined,
+> = WithAdditional<
+  EventDataParams<
+    TEventData,
+    BaseParams<{
+      config: TConfig
+    }>
+  >,
+  TAdditionalParams
+>
+
+export type AccountModuleParams<
+  TConfig extends AnyConfigSchema<ModuleConfig>,
+  TEventData extends EventData | undefined = undefined,
+  TAdditionalParams extends AnyObject | undefined = undefined,
+> = BasicModuleParams<
+  TConfig,
+  TEventData,
+  WithAdditional<
+    {
+      account: AccountInstance
+    },
+    TAdditionalParams
+  >
+>
+
+export type WalletModuleParams<
+  TConfig extends AnyConfigSchema<ModuleConfig>,
+  TEventData extends EventData | undefined = undefined,
+  TAdditionalParams extends AnyObject | undefined = undefined,
+> = BasicModuleParams<
+  TConfig,
+  TEventData,
+  WithAdditional<
+    {
+      accountDerivationPath: string
+      wallet: WalletInstance
+    },
+    TAdditionalParams
+  >
+>
+
+export type ModuleParams<
+  TConfig extends AnyConfigSchema<ModuleConfig> = AnyConfigSchema<ModuleConfig>,
+  TEventData extends EventData | undefined = undefined,
+  TAdditionalParams extends AnyObject | undefined = undefined,
+> =
+  | AccountModuleParams<TConfig, TEventData, TAdditionalParams>
+  | WalletModuleParams<TConfig, TEventData, TAdditionalParams>
+  | BasicModuleParams<TConfig, TEventData, TAdditionalParams>
+
+export type AnyConfigSchema<TConfig extends Omit<ModuleConfig, 'schema'> & { schema: string }> = ModuleConfig<
+  WithAdditional<
+    Omit<TConfig, 'schema'>,
+    {
+      schema: string
+    }
+  >
+>
+
+export type OptionalConfigSchema<TConfig extends AnyConfigSchema<ModuleConfig>> = Omit<TConfig, 'schema'> & { schema?: TConfig['schema'] }

package/src/ModuleQueried.ts

@@ -0,0 +1,16 @@
+import { XyoBoundWitness } from '@xyo-network/boundwitness-model'
+import { EventData } from '@xyo-network/module-events'
+import { XyoPayload } from '@xyo-network/payload-model'
+
+import { ModuleEventArgs } from './ModuleEventArgs'
+import { XyoQueryBoundWitness } from './Query'
+
+export type ModuleQueriedEventArgs = ModuleEventArgs<{
+  payloads?: XyoPayload[]
+  query: XyoQueryBoundWitness
+  result: [XyoBoundWitness, XyoPayload[]]
+}>
+
+export interface ModuleEventData extends EventData {
+  moduleQueried: ModuleQueriedEventArgs
+}

package/src/index.ts

@@ -1,8 +1,12 @@
 export * from './Config'
-export * from './Events'
-export * from './model'
+export * from './CreatableModule'
+export * from './Module'
+export * from './ModuleDescription'
+export * from './ModuleEventArgs'
 export * from './ModuleFilter'
+export * from './ModuleParams'
+export * from './ModuleQueried'
 export * from './ModuleQueryResult'
-export * from './PartialConfig'
+export * from './ModuleRepository'
 export * from './Queries'
 export * from './Query'

package/dist/cjs/Events/EventArgs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EventArgs.js","sourceRoot":"","sources":["../../../src/Events/EventArgs.ts"],"names":[],"mappings":""}

package/dist/cjs/Events/EventListener.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"EventListener.js","sourceRoot":"","sources":["../../../src/Events/EventListener.ts"],"names":[],"mappings":""}

package/dist/cjs/Events/ModuleEventEmitter.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ModuleEventEmitter.js.map

package/dist/cjs/Events/ModuleEventEmitter.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ModuleEventEmitter.js","sourceRoot":"","sources":["../../../src/Events/ModuleEventEmitter.ts"],"names":[],"mappings":""}

package/dist/cjs/Events/ModuleQueried.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModuleQueriedEvent = void 0;
-exports.ModuleQueriedEvent = 'moduleQueried';
-//# sourceMappingURL=ModuleQueried.js.map

package/dist/cjs/Events/ModuleQueried.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ModuleQueried.js","sourceRoot":"","sources":["../../../src/Events/ModuleQueried.ts"],"names":[],"mappings":";;;AAUa,QAAA,kBAAkB,GAAuB,eAAe,CAAA"}

package/dist/cjs/Events/index.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./EventArgs"), exports);
-tslib_1.__exportStar(require("./EventListener"), exports);
-tslib_1.__exportStar(require("./ModuleEventEmitter"), exports);
-tslib_1.__exportStar(require("./ModuleQueried"), exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/Events/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/Events/index.ts"],"names":[],"mappings":";;;AAAA,sDAA2B;AAC3B,0DAA+B;AAC/B,+DAAoC;AACpC,0DAA+B"}

package/dist/cjs/PartialConfig.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"PartialConfig.js","sourceRoot":"","sources":["../../src/PartialConfig.ts"],"names":[],"mappings":""}

package/dist/cjs/model/ModuleDescription.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ModuleDescription.js","sourceRoot":"","sources":["../../../src/model/ModuleDescription.ts"],"names":[],"mappings":""}

package/dist/cjs/model/ModuleRepository.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ModuleRepository.js","sourceRoot":"","sources":["../../../src/model/ModuleRepository.ts"],"names":[],"mappings":""}

package/dist/cjs/model/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-tslib_1.__exportStar(require("./Module"), exports);
-tslib_1.__exportStar(require("./ModuleDescription"), exports);
-tslib_1.__exportStar(require("./ModuleRepository"), exports);
-//# sourceMappingURL=index.js.map

package/dist/cjs/model/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/model/index.ts"],"names":[],"mappings":";;;AAAA,mDAAwB;AACxB,8DAAmC;AACnC,6DAAkC"}

package/dist/esm/Events/EventArgs.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=EventArgs.js.map