genlayer/src/lib/interfaces/ISimulatorService.ts

GenLayer Command Line Tool

import {AiProviders} from "../config/simulator";

export interface ISimulatorService {
  setComposeOptions(headless: boolean, disableOllama?: boolean): void;
  getComposeOptions(): string;
  checkInstallRequirements(): Promise<Record<string, boolean>>;
  checkVersionRequirements(): Promise<Record<string, string>>;
  runSimulator(): Promise<{stdout: string; stderr: string}>;
  waitForSimulatorToBeReady(retries?: number): Promise<WaitForSimulatorToBeReadyResultType>;
  createRandomValidators(numValidators: number, llmProviders: AiProviders[]): Promise<any>;
  deleteAllValidators(): Promise<any>;
  getAiProvidersOptions(withHint: boolean, excludeProviders?: AiProviders[]): Array<{name: string; value: string}>;
  getFrontendUrl(): string;
  openFrontend(): Promise<boolean>;
  stopDockerContainers(): Promise<void>;
  resetDockerContainers(): Promise<void>;
  resetDockerImages(): Promise<void>;
  resetDockerVolumes(): Promise<void>;
  checkCliVersion(): Promise<void>;
  cleanDatabase(): Promise<boolean>;
  addConfigToEnvFile(newConfig: Record<string, string>): void;
  normalizeLocalnetVersion(version: string): string;
  compareVersions(version1: string, version2: string): number;
  isLocalnetRunning(): Promise<boolean>;
}


export type WaitForSimulatorToBeReadyResultType = {
  initialized: boolean;
  errorCode?: "TIMEOUT" | "ERROR";
  errorMessage?: string;
};

export type InitializeDatabaseResultType = {
  createResponse: any;
  tablesResponse: any;
};