genlayer 0.0.31 → 0.0.32-beta.0

package/jest.config.js

@@ -1,8 +1,4 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} */
 module.exports = {
-  preset: "ts-jest",
-  testEnvironment: "node",
-  moduleNameMapper: {
-    "^@/(.*)$": "<rootDir>/src/$1",
-  },
+  preset: "ts-jest/presets/default-esm",
 };

package/package.json

@@ -1,16 +1,17 @@
 {
   "name": "genlayer",
-  "version": "0.0.31",
+  "version": "0.0.32-beta.0",
   "description": "GenLayer Command Line Tool",
   "main": "src/index.ts",
   "bin": {
     "genlayer": "./dist/index.js"
   },
   "scripts": {
-    "test": "jest",
+    "test": "cross-env NODE_OPTIONS=--experimental-vm-modules jest --watch",
     "dev": "cross-env NODE_ENV=development node esbuild.config.js",
     "build": "cross-env NODE_ENV=production node esbuild.config.js",
-    "release": "release-it --ci"
+    "release": "release-it --ci",
+    "release-beta": "release-it --ci --preRelease=beta"
   },
   "repository": {
     "type": "git",
@@ -47,7 +48,7 @@
     "jest": "^29.7.0",
     "prettier": "^3.2.5",
     "release-it": "^17.2.0",
-    "ts-jest": "^29.1.2",
+    "ts-jest": "^29.1.3",
     "ts-node": "^10.9.2",
     "typescript": "^5.4.5"
   },
@@ -55,7 +56,7 @@
     "commander": "^12.0.0",
     "dotenv": "^16.4.5",
     "inquirer": "^9.2.19",
-    "node-fetch": "^3.3.2",
+    "node-fetch": "^2.7.0",
     "open": "^10.1.0",
     "uuid": "^9.0.1"
   }

package/src/commands/general/index.ts

@@ -1,14 +1,17 @@
 import {Command} from "commander";
 
-import {initAction} from "./init";
-import {startAction} from "./start";
+import simulatorService from "../../lib/services/simulator";
+
+import {initAction, InitActionOptions} from "./init";
+import {startAction, StartActionOptions} from "./start";
 
 export function initializeGeneralCommands(program: Command) {
   program
     .command("init")
     .description("Initialize the GenLayer Environment")
-    .option("-n, --numValidators <numValidators>", "Number of validators", "5")
-    .action(initAction);
+    .option("--numValidators <numValidators>", "Number of validators", "5")
+    .option("--branch <branch>", "Branch", "main")
+    .action((options: InitActionOptions) => initAction(options, simulatorService));
 
   program
     .command("up")
@@ -16,7 +19,8 @@ export function initializeGeneralCommands(program: Command) {
     .option("--no-reset-accounts", "Don't restart the database for accouts and transactions", true)
     .option("--reset-validators", "Remove all current validators and create new random ones", false)
     .option("--numValidators <numValidators>", "Number of validators", "5")
-    .action(startAction);
+    .option("--branch <branch>", "Branch", "main")
+    .action((options: StartActionOptions) => startAction(options, simulatorService));
 
   return program;
 }

package/src/commands/general/init.ts

@@ -1,27 +1,10 @@
 import inquirer from "inquirer";
 
-import {AI_PROVIDERS_CONFIG, AiProviders} from "@/lib/config/simulator";
-import {
-  initializeDatabase,
-  checkRequirements,
-  downloadSimulator,
-  configSimulator,
-  runSimulator,
-  waitForSimulatorToBeReady,
-  updateSimulator,
-  clearAccountsAndTransactionsDatabase,
-  createRandomValidators,
-  deleteAllValidators,
-  pullOllamaModel,
-  getAiProvidersOptions,
-  getSimulatorLocation,
-  getFrontendUrl,
-  openFrontend,
-  resetDockerContainers,
-  resetDockerImages,
-} from "@/lib/services/simulator";
+import {ISimulatorService} from "../../lib/interfaces/ISimulatorService";
+import {AI_PROVIDERS_CONFIG, AiProviders} from "../../lib/config/simulator";
 export interface InitActionOptions {
   numValidators: number;
+  branch: string;
 }
 
 function getRequirementsErrorMessage({git, docker}: Record<string, boolean>): string {
@@ -37,12 +20,10 @@ function getRequirementsErrorMessage({git, docker}: Record<string, boolean>): st
   return "";
 }
 
-export async function initAction(options: InitActionOptions) {
-  console.log(`Initializing GenLayer CLI with ${options.numValidators} validators`);
-
+export async function initAction(options: InitActionOptions, simulatorService: ISimulatorService) {
   // Check if git and docker are installed
   try {
-    const {git, docker} = await checkRequirements();
+    const {git, docker} = await simulatorService.checkRequirements();
     const errorMessage = getRequirementsErrorMessage({git, docker});
     if (errorMessage) {
       console.log(
@@ -56,11 +37,28 @@ export async function initAction(options: InitActionOptions) {
     return;
   }
 
+  // Ask for confirmation on reseting the GenLayer Simulator from GitHub
+  const resetAnswers = await inquirer.prompt([
+    {
+      type: "confirm",
+      name: "confirmReset",
+      message: `This command is going to reset GenLayer docker images and containers, providers API Keys, and GenLayer database (accounts, transactions, and validators). Do you want to continue?`,
+      default: true,
+    },
+  ]);
+
+  if (!resetAnswers.confirmReset) {
+    console.log("Aborted!");
+    return;
+  }
+
+  console.log(`Initializing GenLayer CLI with ${options.numValidators} validators`);
+
   // Reset Docker containers and images
   console.log(`Resetting Docker containers and images...`);
   try {
-    await resetDockerContainers();
-    await resetDockerImages();
+    await simulatorService.resetDockerContainers();
+    await simulatorService.resetDockerImages();
   } catch (error) {
     console.error(error);
     return;
@@ -71,7 +69,7 @@ export async function initAction(options: InitActionOptions) {
     {
       type: "confirm",
       name: "confirmDownload",
-      message: `This action is going to download the GenLayer Simulator from GitHub into "${getSimulatorLocation()}". Do you want to continue?`,
+      message: `This action is going to download the GenLayer Simulator from GitHub (branch ${options.branch}) into "${simulatorService.getSimulatorLocation()}". Do you want to continue?`,
       default: true,
     },
   ]);
@@ -84,9 +82,9 @@ export async function initAction(options: InitActionOptions) {
   // Download the GenLayer Simulator from GitHub
   console.log(`Downloading GenLayer Simulator from GitHub...`);
   try {
-    const {wasInstalled} = await downloadSimulator();
+    const {wasInstalled} = await simulatorService.downloadSimulator(options.branch);
     if (wasInstalled) {
-      await updateSimulator();
+      await simulatorService.updateSimulator(options.branch);
     }
   } catch (error) {
     console.error(error);
@@ -99,7 +97,7 @@ export async function initAction(options: InitActionOptions) {
       type: "checkbox",
       name: "selectedLlmProviders",
       message: "Select which LLM providers do you want to use:",
-      choices: getAiProvidersOptions(true),
+      choices: simulatorService.getAiProvidersOptions(true),
       validate: function (answer: string[]) {
         if (answer.length < 1) {
           return "You must choose at least one option.";
@@ -141,7 +139,7 @@ export async function initAction(options: InitActionOptions) {
 
   console.log("Configuring GenLayer Simulator environment...");
   try {
-    await configSimulator(aiProvidersEnvVars);
+    await simulatorService.configSimulator(aiProvidersEnvVars);
   } catch (error) {
     console.error(error);
     return;
@@ -150,14 +148,15 @@ export async function initAction(options: InitActionOptions) {
   // Run the GenLayer Simulator
   console.log("Running the GenLayer Simulator...");
   try {
-    runSimulator();
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    await simulatorService.runSimulator();
   } catch (error) {
     console.error(error);
     return;
   }
 
   try {
-    const {initialized, errorCode, errorMessage} = await waitForSimulatorToBeReady();
+    const {initialized, errorCode, errorMessage} = await simulatorService.waitForSimulatorToBeReady();
     if (!initialized && errorCode === "ERROR") {
       console.log(errorMessage);
       console.error("Unable to initialize the GenLayer simulator. Please try again.");
@@ -178,16 +177,16 @@ export async function initAction(options: InitActionOptions) {
   // Ollama doesn't need changes in configuration, we just run it
   if (selectedLlmProviders.includes("ollama")) {
     console.log("Pulling llama3 from Ollama...");
-    await pullOllamaModel();
+    await simulatorService.pullOllamaModel();
   }
 
   // Initialize the database
   console.log("Initializing the database...");
   try {
     //remove everything from the database
-    await clearAccountsAndTransactionsDatabase();
+    await simulatorService.clearAccountsAndTransactionsDatabase();
 
-    const {createResponse, tablesResponse} = await initializeDatabase();
+    const {createResponse, tablesResponse} = await simulatorService.initializeDatabase();
     if (!createResponse || !tablesResponse) {
       console.error("Unable to initialize the database. Please try again.");
       return;
@@ -201,9 +200,9 @@ export async function initAction(options: InitActionOptions) {
   console.log("Initializing validators...");
   try {
     //remove all validators
-    await deleteAllValidators();
+    await simulatorService.deleteAllValidators();
     // create random validators
-    await createRandomValidators(Number(options.numValidators), selectedLlmProviders);
+    await simulatorService.createRandomValidators(Number(options.numValidators), selectedLlmProviders);
   } catch (error) {
     console.error("Unable to initialize the validators.");
     console.error(error);
@@ -212,10 +211,11 @@ export async function initAction(options: InitActionOptions) {
 
   // Simulator ready
   console.log(
-    `GenLayer simulator initialized successfully! Go to ${getFrontendUrl()} in your browser to access it.`,
+    `GenLayer simulator initialized successfully! Go to ${simulatorService.getFrontendUrl()} in your browser to access it.`,
   );
   try {
-    openFrontend();
+    // eslint-disable-next-line @typescript-eslint/no-floating-promises
+    simulatorService.openFrontend();
   } catch (error) {
     console.error(error);
   }

package/src/commands/general/start.ts

@@ -1,26 +1,16 @@
 import inquirer from "inquirer";
 
-import {
-  updateSimulator,
-  runSimulator,
-  waitForSimulatorToBeReady,
-  deleteAllValidators,
-  createRandomValidators,
-  clearAccountsAndTransactionsDatabase,
-  initializeDatabase,
-  getFrontendUrl,
-  openFrontend,
-  getAiProvidersOptions,
-} from "@/lib/services/simulator";
+import {ISimulatorService} from "../../lib/interfaces/ISimulatorService";
 
 export interface StartActionOptions {
   resetAccounts: string;
   resetValidators: string;
   numValidators: number;
+  branch: string;
 }
 
-export async function startAction(options: StartActionOptions) {
-  const {resetAccounts, resetValidators, numValidators} = options;
+export async function startAction(options: StartActionOptions, simulatorService: ISimulatorService) {
+  const {resetAccounts, resetValidators, numValidators, branch} = options;
 
   const restartAccountsHintText = resetAccounts
     ? "restarting the accounts and transactions database"
@@ -35,7 +25,7 @@ export async function startAction(options: StartActionOptions) {
   // Update the simulator to the latest version
   console.log(`Updating GenLayer Simulator...`);
   try {
-    await updateSimulator();
+    await simulatorService.updateSimulator(branch);
   } catch (error) {
     console.error(error);
     return;
@@ -44,14 +34,14 @@ export async function startAction(options: StartActionOptions) {
   // Run the GenLayer Simulator
   console.log("Running the GenLayer Simulator...");
   try {
-    runSimulator();
+    await simulatorService.runSimulator();
   } catch (error) {
     console.error(error);
     return;
   }
 
   try {
-    const {initialized, errorCode, errorMessage} = await waitForSimulatorToBeReady();
+    const {initialized, errorCode, errorMessage} = await simulatorService.waitForSimulatorToBeReady();
     if (!initialized && errorCode === "ERROR") {
       console.log(errorMessage);
       console.error("Unable to initialize the GenLayer simulator. Please try again.");
@@ -74,9 +64,9 @@ export async function startAction(options: StartActionOptions) {
     console.log("Initializing the database...");
     try {
       //remove everything from the database
-      await clearAccountsAndTransactionsDatabase();
+      await simulatorService.clearAccountsAndTransactionsDatabase();
 
-      const {createResponse, tablesResponse} = await initializeDatabase();
+      const {createResponse, tablesResponse} = await simulatorService.initializeDatabase();
       if (!createResponse || !tablesResponse) {
         console.error("Unable to initialize the database. Please try again.");
         return;
@@ -93,13 +83,13 @@ export async function startAction(options: StartActionOptions) {
     console.log("Initializing validators...");
     try {
       //remove all validators
-      await deleteAllValidators();
+      await simulatorService.deleteAllValidators();
       const questions = [
         {
           type: "checkbox",
           name: "selectedLlmProviders",
           message: "Select which LLM providers do you want to use:",
-          choices: getAiProvidersOptions(false),
+          choices: simulatorService.getAiProvidersOptions(false),
           validate: function (answer: string[]) {
             if (answer.length < 1) {
               return "You must choose at least one option.";
@@ -113,7 +103,10 @@ export async function startAction(options: StartActionOptions) {
       const llmProvidersAnswer = await inquirer.prompt(questions);
 
       // create random validators
-      await createRandomValidators(Number(options.numValidators), llmProvidersAnswer.selectedLlmProviders);
+      await simulatorService.createRandomValidators(
+        Number(options.numValidators),
+        llmProvidersAnswer.selectedLlmProviders,
+      );
     } catch (error) {
       console.error("Unable to initialize the validators.");
       console.error(error);
@@ -124,10 +117,10 @@ export async function startAction(options: StartActionOptions) {
 
   // Simulator ready
   console.log(
-    `GenLayer simulator initialized successfully! Go to ${getFrontendUrl()} in your browser to access it.`,
+    `GenLayer simulator initialized successfully! Go to ${simulatorService.getFrontendUrl()} in your browser to access it.`,
   );
   try {
-    openFrontend();
+    simulatorService.openFrontend();
   } catch (error) {
     console.error(error);
   }

package/src/lib/clients/system.ts

@@ -3,7 +3,7 @@ import {ChildProcess, PromiseWithChild, exec} from "child_process";
 import os from "os";
 import open from "open";
 
-import {RunningPlatform, AVAILABLE_PLATFORMS} from "@/lib/config/simulator";
+import {RunningPlatform, AVAILABLE_PLATFORMS} from "../config/simulator";
 import {MissingRequirementError} from "../errors/missingRequirement";
 
 const asyncExec = util.promisify(exec);

package/src/lib/interfaces/ISimulatorService.ts

@@ -0,0 +1,38 @@
+import {AiProviders} from "../config/simulator";
+
+export interface ISimulatorService {
+  getSimulatorLocation(): string;
+  readEnvConfigValue(key: string): string;
+  addConfigToEnvFile(newConfig: Record<string, string>): void;
+  checkRequirements(): Promise<Record<string, boolean>>;
+  downloadSimulator(branch?: string): Promise<DownloadSimulatorResultType>;
+  updateSimulator(branch?: string): Promise<boolean>;
+  pullOllamaModel(): Promise<boolean>;
+  configSimulator(newConfig: Record<string, string>): Promise<boolean>;
+  runSimulator(): Promise<{stdout: string; stderr: string}>;
+  waitForSimulatorToBeReady(retries?: number): Promise<WaitForSimulatorToBeReadyResultType>;
+  clearAccountsAndTransactionsDatabase(): Promise<any>;
+  initializeDatabase(): Promise<InitializeDatabaseResultType>;
+  createRandomValidators(numValidators: number, llmProviders: AiProviders[]): Promise<any>;
+  deleteAllValidators(): Promise<any>;
+  getAiProvidersOptions(withHint: boolean): Array<{name: string; value: string}>;
+  getFrontendUrl(): string;
+  openFrontend(): Promise<boolean>;
+  resetDockerContainers(): Promise<boolean>;
+  resetDockerImages(): Promise<boolean>;
+}
+
+export type DownloadSimulatorResultType = {
+  wasInstalled: boolean;
+};
+
+export type WaitForSimulatorToBeReadyResultType = {
+  initialized: boolean;
+  errorCode?: "TIMEOUT" | "ERROR";
+  errorMessage?: string;
+};
+
+export type InitializeDatabaseResultType = {
+  createResponse: any;
+  tablesResponse: any;
+};