Merge pull request #21

Added xExplorer

Author: gfusee

cli/src/config/config.ts

@@ -4,6 +4,7 @@ export type CLIConfig = {
     shouldHaveRedis: boolean
     shouldHaveRabbitMQ: boolean
     shouldHaveApi: boolean
+    shouldHaveXExplorer: boolean
     numberOfShards: number
     initialEGLDAddress?: string
     mxOpsScenesPath?: string
@@ -16,6 +17,7 @@ export function getDefaultConfig(): CLIConfig {
         shouldHaveRedis: false,
         shouldHaveRabbitMQ: false,
         shouldHaveApi: false,
+        shouldHaveXExplorer: false,
         numberOfShards: 1
     }
 }

cli/src/config/constants.ts

@@ -55,6 +55,13 @@ export class Constants {
         }
     }
 
+    static get XEXPLORER_CONTAINER(): ContainerInfos {
+        return {
+            name: "xexplorer",
+            pauseBehavior: PauseBehavior.STOP
+        }
+    }
+
     static get ELASTIC_CONTAINER(): ContainerInfos {
         return {
             name: "elastic",

cli/src/questions/features/featuresQuestion.ts

@@ -2,32 +2,47 @@ import {CLIChoice, CLIQuestion} from "../question.js";
 import {Answers, CheckboxQuestion, Question} from "inquirer";
 import {CLIConfig} from "../../config/config";
 import {MxOpsScenesPathQuestion} from "./mxOpsScenesPathQuestion.js";
+import {CustomAddressToGiveEGLDQuestion} from "./customAddressToGiveEGLDQuestion.js";
 
-export abstract class FeaturesQuestion extends CLIQuestion {
+export class FeaturesQuestion extends CLIQuestion {
 
     private static apiChoice = 'Enable full API (like api.multiversx.com)'
+    private static xExplorerChoice = 'Enable xExplorer, requires the full API'
     private static mxOpsChoice = 'Run MxOps scenes at startup'
+    static readonly giveToCustomAddressChoice = 'Give 1,000,000 EGLD to a custom address (otherwise a new one will be generated for you)'
 
     override async getQuestion(): Promise<Question> {
         const question: CheckboxQuestion = {
             type: 'checkbox',
             name: 'choice',
             message: 'Which features do you want to enable ?',
-            choices: this.generalFeatures.concat(this.cliChoices)
+            choices: this.generalFeatures
         }
 
         return question
     }
 
     private generalFeatures: CLIChoice[] = [
         FeaturesQuestion.apiChoice,
-        FeaturesQuestion.mxOpsChoice
+        FeaturesQuestion.xExplorerChoice,
+        FeaturesQuestion.mxOpsChoice,
+        FeaturesQuestion.giveToCustomAddressChoice
     ]
 
-    abstract cliChoices: CLIChoice[]
-
     override async handleAnswer(answers: Answers, config: CLIConfig): Promise<CLIQuestion[]> {
-        if (answers.choice.includes(FeaturesQuestion.apiChoice)) {
+        const hasAPI = answers.choice.includes(FeaturesQuestion.apiChoice)
+        if (answers.choice.includes(FeaturesQuestion.xExplorerChoice)) {
+            if (hasAPI) {
+                config.shouldHaveXExplorer = true
+            } else {
+                const errorMessage = '\n❌ You have to opt for the full API in order to run xExplorer.\n'
+                console.log(errorMessage)
+
+                return [new FeaturesQuestion()]
+            }
+        }
+
+        if (hasAPI) {
             config.shouldHaveElasticSearch = true
             config.shouldHaveMySQL = true
             config.shouldHaveRabbitMQ = true
@@ -41,6 +56,10 @@ export abstract class FeaturesQuestion extends CLIQuestion {
             questions.push(new MxOpsScenesPathQuestion())
         }
 
+        if (answers.choice.includes(FeaturesQuestion.giveToCustomAddressChoice)) {
+            questions.push(new CustomAddressToGiveEGLDQuestion())
+        }
+
         return questions
     }
 }

cli/src/questions/features/freshLocalnetFeaturesQuestion.ts

@@ -1,7 +1,7 @@
 import {CLIQuestion} from "../question.js";
-import {FreshLocalnetFeaturesQuestion} from "../features/freshLocalnetFeaturesQuestion.js";
 import {Answers, Question} from "inquirer";
 import {CLIConfig} from "../../config/config.js";
+import {FeaturesQuestion} from "../features/featuresQuestion.js";
 
 export class NumberShardsQuestion extends CLIQuestion {
 
@@ -31,6 +31,6 @@ export class NumberShardsQuestion extends CLIQuestion {
 
         config.numberOfShards = answers.numberShards
 
-        return [new FreshLocalnetFeaturesQuestion()]
+        return [new FeaturesQuestion()]
     }
 }

cli/src/questions/features/shadowForkFeaturesQuestion.ts

@@ -60,6 +60,16 @@ export async function createNetwork(config: CLIConfig) {
             startingApiHealthCheckSpinner.succeed('API is ready')
         }
 
+        if (config.shouldHaveXExplorer) {
+            const startingApiSpinner = ora('Starting xExplorer container...').start()
+            await upContainer(Constants.XEXPLORER_CONTAINER.name)
+            startingApiSpinner.succeed('Started xExplorer container')
+
+            const startingApiHealthCheckSpinner = ora('Waiting for API to be ready').start()
+            await waitForAPIToBeReady()
+            startingApiHealthCheckSpinner.succeed('API is ready')
+        }
+
         if (config.mxOpsScenesPath) {
             const copyingScenesSpinner = ora('Copying mxops scenes...').start()
             await execCustomInRepo(`docker-compose cp ${config.mxOpsScenesPath} localnet:/home/ubuntu/mxops`)

cli/src/questions/fresh/numberShardsQuestion.ts

@@ -0,0 +1,36 @@
+FROM ubuntu:22.04 AS environment
+
+SHELL ["/bin/bash", "-c"]
+
+RUN apt update -y
+RUN apt install sudo -y
+RUN apt install curl -y
+
+RUN adduser --disabled-password --gecos '' ubuntu
+RUN adduser ubuntu sudo
+RUN echo '%sudo ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
+USER ubuntu
+WORKDIR /home/ubuntu
+
+#Python3 setup
+RUN sudo DEBIAN_FRONTEND=noninteractive apt install python3-pip -y
+RUN sudo pip3 install requests
+
+#NodeJS setup
+RUN curl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash - && sudo apt install nodejs -y
+RUN sudo npm i -g yarn
+
+#mx-explorer-dapp setup (nodejs)
+RUN sudo apt install git -y
+RUN git clone https://github.com/multiversx/mx-explorer-dapp.git -b main
+RUN cd mx-explorer-dapp && git checkout 6b9560d83cfa9b2197f1efde651450c9d25508e4
+RUN cd mx-explorer-dapp && yarn
+COPY config.localnet.ts mx-explorer-dapp/src/config/index.ts
+COPY vite.config.ts mx-explorer-dapp/vite.config.ts
+
+COPY wait-for-it.sh .
+RUN sudo chmod +x wait-for-it.sh
+
+COPY run.sh .
+RUN sudo chmod +x run.sh
+CMD ./run.sh

cli/src/questions/shadowfork/shadowForkNetworkQuestion.ts

@@ -0,0 +1,44 @@
+import { NetworkType } from 'types/network.types';
+import { allApps, schema } from './sharedConfig';
+export * from './sharedConfig';
+
+export const networks: NetworkType[] = [
+    {
+        default: true,
+        id: 'localnet',
+        name: 'Localnet',
+        chainId: 'localnet',
+        adapter: 'api',
+        theme: 'testnet',
+        egldLabel: 'tEGLD',
+        walletAddress: 'https://devnet-wallet.multiversx.com',
+        explorerAddress: 'http://localhost:3002',
+        nftExplorerAddress: 'https://devnet.xspotlight.com',
+        apiAddress: 'http://localhost:3001'
+    }
+];
+
+export const multiversxApps = allApps([
+    {
+        id: 'wallet',
+        url: 'https://devnet-wallet.multiversx.com'
+    },
+    {
+        id: 'explorer',
+        url: 'http://localhost:3002'
+    },
+    {
+        id: 'xexchange',
+        url: 'http://devnet.xexchange.com'
+    },
+    {
+        id: 'xspotlight',
+        url: 'https://devnet.xspotlight.com/'
+    }
+]);
+
+networks.forEach((network) => {
+    schema.validate(network, { strict: true }).catch(({ errors }) => {
+        console.error(`Config invalid format for ${network.id}`, errors);
+    });
+});