Function buildModule

packages/ignition-core/src/build-module.ts:20–64

(
  moduleId: ModuleIdT,
  moduleDefinitionFunction: (
    m: IgnitionModuleBuilder,
  ) => IgnitionModuleResultsT,
)

 * @public
 */
export function buildModule<
  ModuleIdT extends string,
  ContractNameT extends string,
  IgnitionModuleResultsT extends IgnitionModuleResult<ContractNameT>,
>(
  moduleId: ModuleIdT,
  moduleDefinitionFunction: (
    m: IgnitionModuleBuilder,
  ) => IgnitionModuleResultsT,
): IgnitionModule<ModuleIdT, ContractNameT, IgnitionModuleResultsT> {
  if (typeof moduleId !== "string") {
    throw new HardhatError(
      HardhatError.ERRORS.IGNITION.MODULE.INVALID_MODULE_ID,
    );
  }

  if (!isValidIgnitionIdentifier(moduleId)) {
    throw new HardhatError(
      HardhatError.ERRORS.IGNITION.MODULE.INVALID_MODULE_ID_CHARACTERS,
      {
        moduleId,
      },
    );
  }

  if (typeof moduleDefinitionFunction !== "function") {
    throw new HardhatError(
      HardhatError.ERRORS.IGNITION.MODULE.INVALID_MODULE_DEFINITION_FUNCTION,
    );
  }

  const constructor = new ModuleConstructor();
  const ignitionModule = constructor.construct<
    ModuleIdT,
    ContractNameT,
    IgnitionModuleResultsT
  >({
    id: moduleId,
    moduleDefinitionFunction,
  });

  _checkForDuplicateModuleIds(ignitionModule);

  return ignitionModule;
}

/**
 * Check to ensure that there are no duplicate module ids among the root