Implemented LssEjector service plugin

Author: SergeevDmitry

controls/roles/manage-service/tasks/main.yml

@@ -42,7 +42,7 @@
       changed_when: false
       become: yes
       when: (stereum.manage_service.state == "started" or stereum.manage_service.state == "restarted") and item.split(':') | first != '/' and item.split(':') | first != '/sys' and item.split(':') | first != '/proc'
-      with_items: "{{ stereum_service_configuration.volumes | reject('search', ':/engine.jwt') }}"
+      with_items: "{{ stereum_service_configuration.volumes | reject('search', ':/engine.jwt') | reject('search', 'all-accounts.keystore.json') | reject('search', 'wallet-password') }}"
 
     - name: Set directory permissions for engine.jwt
       file:

controls/roles/update-services/files/updates.json

@@ -9,6 +9,9 @@
       "GethService": [
           "latest"
       ],
+      "LSSEjector": [
+          "latest"
+      ],
       "PrometheusService": [
           "v2.47.2"
       ],
@@ -29,6 +32,9 @@
       "GethService": [
           "latest"
       ],
+      "LSSEjector": [
+          "latest"
+      ],
       "PrometheusService": [
           "v2.47.2"
       ],

launcher/public/output.css

@@ -2565,6 +2565,10 @@ video {
           animation: spin 1s linear infinite;
 }
 
+.\!cursor-not-allowed{
+  cursor: not-allowed !important;
+}
+
 .cursor-default{
   cursor: default;
 }

launcher/src/backend/ServiceManager.js

@@ -16,6 +16,7 @@ import { MetricsExporterService } from "./ethereum-services/MetricsExporterServi
 import { ExternalConsensusService } from "./ethereum-services/ExternalConsensusService";
 import { ExternalExecutionService } from "./ethereum-services/ExternalExecutionService";
 import { CustomService } from "./ethereum-services/CustomService";
+import { LssEjectorService } from "./ethereum-services/LssEjectorService";
 import { ConfigManager } from "./ConfigManager";
 import YAML from "yaml";
 // import { file } from "jszip";
@@ -124,6 +125,8 @@ export class ServiceManager {
               services.push(ExternalExecutionService.buildByConfiguration(config));
             } else if (config.service == "CustomService") {
               services.push(CustomService.buildByConfiguration(config));
+            } else if (config.service == "LssEjectorService") {
+              services.push(LssEjectorService.buildByConfiguration(config))
             }
           } else {
             log.error("found configuration without service!");
@@ -745,6 +748,13 @@ export class ServiceManager {
           args.consensusClients, // TOOD: remove later!
           args.otherServices
         );
+      case "LssEjectorService":
+        return LssEjectorService.buildByUserInput(
+          args.network,
+          args.executionClients,
+          args.consensusClients,
+          args.otherServices,
+        )
     }
   }
 

launcher/src/backend/ValidatorAccountManager.js

@@ -171,6 +171,14 @@ export class ValidatorAccountManager {
       let pubkeys = this.batches.map((b) => b.keystores.map((c) => JSON.parse(c).pubkey)).flat();
       const message = this.formatImportResult(pubkeys, data);
       this.nodeConnection.taskManager.otherTasksHandler(ref);
+
+      // Restart LssEjectorService if it is installed and is running
+      let serviceInfos = await this.serviceManager.readServiceInfos(services)
+      let lssEjectorClient = serviceInfos.find((service) => service.service === 'LssEjectorService');
+      if (lssEjectorClient) {
+        await this.serviceManager.restartService(lssEjectorClient)
+      }
+
       return message;
     } catch (err) {
       this.nodeConnection.taskManager.otherTasksHandler(ref, `Import Failed`, false, "Validator Import Failed:\n" + err);
@@ -239,6 +247,19 @@ export class ValidatorAccountManager {
       this.nodeConnection.taskManager.otherTasksHandler(ref, `Delete Keys`, true, result.stdout);
 
       this.nodeConnection.taskManager.otherTasksHandler(ref);
+
+      // Restart LssEjectorService if it is installed and is running
+      const serviceInfos = await this.serviceManager.readServiceInfos()
+      const lssEjectorClient = serviceInfos.find((service) => service.service === 'LssEjectorService');
+      const validatorsList = await this.listValidators(serviceID)
+      if (lssEjectorClient && lssEjectorClient.state === 'running') {
+        if (validatorsList.data.length > 0) {
+          await this.serviceManager.restartService(lssEjectorClient)
+        } else {
+          await this.serviceManager.manageServiceState(lssEjectorClient.config.serviceID, "stopped")
+        }
+      }
+
       //Return slashing protection data
       if (picked) return data.slashing_protection;
       return data;

launcher/src/backend/ethereum-services/LssEjectorService.js

@@ -0,0 +1,78 @@
+import { NodeService } from "./NodeService";
+import { ServiceVolume } from "./ServiceVolume";
+
+export class LssEjectorService extends NodeService {
+  static buildByUserInput(network, executionClients, consensusClients, otherServices) {
+    const service = new LssEjectorService();
+    service.setId();
+
+    const executionEndpoint = executionClients
+      .map((client) => {
+        return client.buildExecutionClientHttpEndpointUrl();
+      })
+      .join();
+    const consensusEndpoint = consensusClients.map((client) => {
+      return client.buildConsensusClientHttpEndpointUrl();
+    })
+    .join();
+
+    const allAccountsKeystoreDir = '/config/all-accounts.keystore.json'
+    const walletPasswordDir = '/config/wallet-password'
+
+    const validatorService = otherServices.find(s => s.service.includes('PrysmValidator'))
+
+    const walletsDir = validatorService.volumes.find(
+      (vol) => vol.servicePath === "/wallets" || vol.destinationPath.includes("/wallets")
+    ).destinationPath
+    const passwordsDir = validatorService.volumes.find(
+      (vol) => vol.servicePath === "/passwords" || vol.destinationPath.includes("/passwords")
+    ).destinationPath
+
+    const volumes = [
+      new ServiceVolume(`${walletsDir}/direct/accounts/all-accounts.keystore.json`, allAccountsKeystoreDir, 'ro'),
+      new ServiceVolume(`${passwordsDir}/wallet-password`, walletPasswordDir, 'ro'),
+    ]
+
+    // TODO set default value to a contract address in Stratis network when it is deployed
+    let stakingContractAddress = ''
+    if (network === 'auroria') {
+      stakingContractAddress = '0x0504D06711d02E6275e1724529a801441088f9f4'
+    }
+
+    service.init(
+      "LssEjectorService", //service
+      service.id, // id
+      1, // configVersion
+      "stratisevm/lss-ejector", // image
+      "latest", // imageVersion
+      [
+        "start",
+        '--all_accounts_file',
+        `--consensus_endpoint=${consensusEndpoint}`,
+        `--execution_endpoint=${executionEndpoint}`,
+        `--keys_dir=${allAccountsKeystoreDir}`,
+        `--keystore_password_file=${walletPasswordDir}`,
+        `--staking_address=${stakingContractAddress}`
+      ], // command
+      ["lss-ejector"], // entrypoint
+      null, // env
+      null, // ports
+      volumes, // volumes
+      null, // user
+      network, // network
+      executionClients,
+      consensusClients,
+      null, // mevboost
+      otherServices,
+    );
+    return service;
+  }
+
+  static buildByConfiguration(config) {
+    const service = new LssEjectorService();
+
+    service.initByConfig(config);
+
+    return service;
+  }
+}

launcher/src/components/UI/edit-page/EditScreen.vue

@@ -708,6 +708,10 @@ const selectedServiceToRemove = (item) => {
   );
   if (!itemExists) {
     manageStore.confirmChanges.push(confirmDelete);
+    let lssEjectorService
+    if (item.service === 'PrysmValidatorService' && (lssEjectorService = serviceStore.installedServices.find(s => s.service === 'LssEjectorService'))) {
+      selectedServiceToRemove(lssEjectorService)
+    }
   }
 };
 

launcher/src/components/UI/edit-page/components/changes/ChangesBox.vue

@@ -51,7 +51,18 @@ const manageStore = useNodeManage();
 
 const getChanges = computed(() => manageStore.confirmChanges);
 
+const canCancelLssEjectorDelete = (item) => {
+  if (item.service.service !== 'LssEjectorService' || (item.service.service === 'LssEjectorService' && item.content !== 'DELETE')) {
+    return true
+  }
+
+  return !manageStore.confirmChanges.find(item => item.content === 'DELETE' && item.service.service === 'PrysmValidatorService')
+}
+
 const removeChange = (item) => {
+  if (!canCancelLssEjectorDelete(item)) {
+    return
+  }
   emit("remove-change", item);
 };
 
@@ -62,7 +73,11 @@ const contentBgColor = (item) => {
     if (content === "INSTALL") {
       bg = "bg-green-800 text-gray-100 text-sm font-semibold";
     } else if (content === "DELETE") {
-      bg = "bg-red-800 text-gray-300 text-sm font-semibold";
+      if (canCancelLssEjectorDelete(item)) {
+        bg = "bg-red-800 text-gray-300 text-sm font-semibold";
+      } else {
+        bg = "bg-gray-800 text-gray-300 text-sm font-semibold !cursor-not-allowed";
+      }
     } else if (content === "NETWORK") {
       bg = "bg-teal-700 text-gray-100 text-sm font-semibold min-w-[100px]";
     } else if (content === "SWITCH CLIENT") {

launcher/src/components/UI/edit-page/components/modals/AddConnection.vue

@@ -203,6 +203,9 @@ const toggleConnection = (option) => {
     (e) => (e.category === "consensus" || e.service === "CharonService") && e.isConnected
   );
   props.properties.otherServices = list.value.filter((e) => e.category === "service" && e.isConnected);
+  if (props.client.service === 'LssEjectorService') {
+    props.properties.otherServices = list.value.filter((e) => e.category === "validator" && e.isConnected);
+  }
 };
 
 const getConnectionOptions = () => {
@@ -232,6 +235,9 @@ const getConnectionOptions = () => {
       if (props.client.service === "FlashbotsMevBoostService") {
         return manageStore.newConfiguration.filter((e) => e.category === "consensus");
       }
+      if (props.client.service === "LssEjectorService") {
+        return manageStore.newConfiguration.filter(e => e.category === "execution" || e.category === "consensus" || e.category === "validator")
+      }
       break;
     default:
       return [];

launcher/src/components/UI/edit-page/components/modals/AddModal.vue

@@ -4,7 +4,7 @@
     :client="client"
     :sub-title="getSubTitles"
     :confirm-text="getConfirmText"
-    :disabled-button="disabledButton || externalServiceConfirmBtn"
+    :disabled-button="disabledButton || externalServiceConfirmBtn || lssEjectorEmptyClients"
     click-outside-text="Click outside to cancel"
     @close-window="closeWindow"
     @confirm-action="confirmInstall"
@@ -21,7 +21,7 @@ import CustomModal from "./CustomModal.vue";
 import AddPanel from "./AddPanel";
 import AddConnection from "./AddConnection";
 import MevboostRelays from "./MevboostRelays.vue";
-import { ref, onMounted, computed } from "vue";
+import { ref, onMounted, computed, watchEffect } from "vue";
 import { useNodeManage } from "@/store/nodeManage";
 import { useClickInstall } from "@/store/clickInstallation";
 
@@ -42,6 +42,7 @@ const isAddPanelActivated = ref(false);
 const isRelaysActivated = ref(false);
 const isModifyActivated = ref(false);
 const disabledButton = ref(false);
+const lssEjectorEmptyClients = ref(false)
 // eslint-disable-next-line vue/no-setup-props-destructure
 const properties = ref({
   client: props.client,
@@ -68,6 +69,8 @@ const getConfirmText = computed(() => {
       (props.client.category === "validator" && !/Web3Signer/.test(props.client.service))
     ) {
       text = "next";
+    } else if (props.client.category === "service" && props.client.service === "LssEjectorService") {
+      text = "next"
     } else if (props.client.category === "service" && props.client.service !== "FlashbotsMevBoostService") {
       text = "confirm";
     } else if (props.client.category === "service" && props.client.service === "FlashbotsMevBoostService") {
@@ -93,6 +96,16 @@ const getSubTitles = computed(() => {
   return text;
 });
 
+watchEffect(() => {
+  lssEjectorEmptyClients.value = (
+    props.client.service === "LssEjectorService" &&
+    getConfirmText.value === "confirm" &&
+    (properties.value.executionClients.length === 0 ||
+    properties.value.consensusClients.length === 0 ||
+    properties.value.otherServices.length === 0)
+  )
+})
+
 const externalServiceConfirmBtn = computed(() => {
   if (props.client.service === "ExternalExecutionService") {
     return props.client.config.source === "" || props.client.config.jwtToken === "";
@@ -118,7 +131,8 @@ const confirmInstall = () => {
     emit("confirmInstall", properties.value);
   } else if (
     (props.client.category === "consensus" && getConfirmText.value === "next") ||
-    (props.client.category === "validator" && getConfirmText.value === "next")
+    (props.client.category === "validator" && getConfirmText.value === "next") ||
+    (props.client.category === "service" && props.client.service === "LssEjectorService" && getConfirmText.value === "next")
   ) {
     isAddPanelActivated.value = false;
     isModifyActivated.value = true;