Class ModuleFactory<TModule>

constructor

• new ModuleFactory<
      TModule extends
          AttachableModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig>;
                  ephemeralQueryAccountEnabled?: boolean;
                  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                  privateChildren?: ModuleInstance<
                      (
                          BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                      ),
                      ModuleEventData<object>,
                  >[];
                  publicChildren?: ModuleInstance<
                      (
                          BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                      ),
                      ModuleEventData<object>,
                  >[];
              },
              ModuleEventData<object>,
          >,
  >(
      creatableModule: CreatableModule<TModule>,
      params?: Omit<TModule["params"], "config"> & {
          config?: Partial<TModule["params"]["config"]>;
      },
      labels?: Labels,
  ): ModuleFactory<TModule>

  Type Parameters

  • TModule extends AttachableModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                (
                    BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                ),
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                (
                    BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                ),
                ModuleEventData<object>,
            >[];
        },
        ModuleEventData<object>,
    >

  Parameters

  • creatableModule: CreatableModule<TModule>
  • Optionalparams: Omit<TModule["params"], "config"> & {
        config?: Partial<TModule["params"]["config"]>;
    }
  • labels: Labels = {}

  Returns ModuleFactory<TModule>

configSchemas

creatableModule

defaultConfigSchema

OptionaldefaultLogger

OptionaldefaultParams

Optionallabels

_getRootFunction

• _getRootFunction(funcName: string): any

  Parameters

  • funcName: string

  Returns any

_noOverride

• _noOverride(functionName: string): void

  Parameters

  • functionName: string

  Returns void

create

• create<
      T extends
          AttachableModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig>;
                  ephemeralQueryAccountEnabled?: boolean;
                  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                  privateChildren?: ModuleInstance<
                      (
                          BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                      ),
                      ModuleEventData<object>,
                  >[];
                  publicChildren?: ModuleInstance<
                      (
                          BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                      ),
                      ModuleEventData<object>,
                  >[];
              },
              ModuleEventData<object>,
          >,
  >(
      this: CreatableModuleFactory<T>,
      params: TModule["params"],
  ): Promise<T>

  Type Parameters

  • T extends AttachableModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                (
                    BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                ),
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                (
                    BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                ),
                ModuleEventData<object>,
            >[];
        },
        ModuleEventData<object>,
    >

  Parameters

  • this: CreatableModuleFactory<T>
  • params: TModule["params"]

  Returns Promise<T>

factory

• factory<
      T extends
          AttachableModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig>;
                  ephemeralQueryAccountEnabled?: boolean;
                  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                  privateChildren?: ModuleInstance<
                      (
                          BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                      ),
                      ModuleEventData<object>,
                  >[];
                  publicChildren?: ModuleInstance<
                      (
                          BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                      ),
                      ModuleEventData<object>,
                  >[];
              },
              ModuleEventData<object>,
          >,
  >(
      this: CreatableModule<T>,
      _params?: T["params"],
  ): CreatableModuleFactory<T>

  Type Parameters

  • T extends AttachableModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                (
                    BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                ),
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                (
                    BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                ),
                ModuleEventData<object>,
            >[];
        },
        ModuleEventData<object>,
    >

  Parameters

  • this: CreatableModule<T>
  • Optional_params: T["params"]

  Returns CreatableModuleFactory<T>

StaticwithParams

• withParams<
      T extends
          AttachableModuleInstance<
              BaseParamsFields & {
                  account?: AccountInstance
                  | "random";
                  additionalSigners?: AccountInstance[];
                  addToResolvers?: boolean;
                  allowNameResolution?: boolean;
                  config: AnyConfigSchema<ModuleConfig>;
                  ephemeralQueryAccountEnabled?: boolean;
                  moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
                  privateChildren?: ModuleInstance<
                      (
                          BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                      ),
                      ModuleEventData<object>,
                  >[];
                  publicChildren?: ModuleInstance<
                      (
                          BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                      ),
                      ModuleEventData<object>,
                  >[];
              },
              ModuleEventData<object>,
          >,
  >(
      creatableModule: CreatableModule<T>,
      params?: Omit<T["params"], "config"> & { config?: T["params"]["config"] },
      labels?: Labels,
  ): ModuleFactory<T>

  Type Parameters

  • T extends AttachableModuleInstance<
        BaseParamsFields & {
            account?: AccountInstance
            | "random";
            additionalSigners?: AccountInstance[];
            addToResolvers?: boolean;
            allowNameResolution?: boolean;
            config: AnyConfigSchema<ModuleConfig>;
            ephemeralQueryAccountEnabled?: boolean;
            moduleIdentifierTransformers?: ModuleIdentifierTransformer[];
            privateChildren?: ModuleInstance<
                (
                    BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                ),
                ModuleEventData<object>,
            >[];
            publicChildren?: ModuleInstance<
                (
                    BaseParamsFields & { account?: AccountInstance | "random" | undefined; addToResolvers?: boolean | undefined; additionalSigners?: AccountInstance[] | undefined; ... 5 more ...; publicChildren?: ModuleInstance<...>[] | undefined; }
                ),
                ModuleEventData<object>,
            >[];
        },
        ModuleEventData<object>,
    >

  Parameters

  • creatableModule: CreatableModule<T>
  • Optionalparams: Omit<T["params"], "config"> & { config?: T["params"]["config"] }
  • labels: Labels = {}

  Returns ModuleFactory<T>