Setup a boilerplate V8 Edge node

Setting up a "boilerplate" node project to explore its capabilities and build your own projects. As an open-source solution, the node offers complete customization to fit your needs.

This is the first version of the V8 Edge node documentation and your feedback and contributions are much appreciated.

Currently, the setup options require manual configuration, involving several steps to install and configure the necessary components.

This setup will take some time, so grab a coffee and be ready to dive deep into the internals of the node.

The core developers are working on automated development environment setup, and would love to hear your feedback.

To set up the DKG Edge Node in your local environment, you can choose between the following two options:

1. [Recommended] Set up local Edge Node services with a local DKG network

2. Configure local Edge Node services with a pre-deployed V8 DKG Core testnet node

Manual development environment setup

Setup with a local DKG network

This option allows you to configure the Edge Node services within your local development environment, utilizing a locally deployed DKG network. This setup provides full control over the environment and is ideal for developing custom processing pipelines and testing in a self-contained network.

System Requirements

• Operating System: macOS, Linux

• RAM: At least 8 GB

• CPU: 4

• Storage: At least 20 GB available space

• Network: Stable internet connection

Software Dependencies

Make sure the following services are installed and properly configured:

• Git: Version control system

• MySQL 8: Database service

• Redis: In-memory data structure store (documentation)

• Node.js: JavaScript runtime environment

  • v20.04: Used for the local network/ot-node setup

  • v22.4.0: Used for Edge node services

• v11: for running blazegraph triple store

• Python v3.11.7

We recommend using NVM and Pyenv in order to be able to switch Node.js versions easily and install Python.

Setup process

1 - Setting up local DKG network:

Edge Node services require a V8 DKG Runtime Node endpoint in order to be configured and initialized so for this setup, running a local DKG network is essential.

In order to deploy a local DKG network, do the following:

• Clone the OriginTrail node: git clone https://github.com/OriginTrail/ot-node

• Enter ot-node directory and checkout to v8/develop branch: cd ot-node && git checkout v8/stable-development-network

• Switch to Node.js v20 and install node modules: npm install

• Download blazegraph.jar (Triple store db) from the following link and save it to location of your choice locally

• Run blazegraph.jar file with the following command: java -server -Xmx4g -jar blazegraph.jar in order to start the triple store database (from the directory where blazegraph is downloaded)

• Make sure that the MySQL service is running

• In ot-node directory, create .env file in ot-node directory and populate it with the following parameters (If your mysql is password protected, add the password to REPOSITORY_PASSWORD):

NODE_ENV=development
RPC_ENDPOINT_BC1=http://127.0.0.1:8545
RPC_ENDPOINT_BC2=http://127.0.0.1:9545
REPOSITORY_PASSWORD=

• Start the local DKG network by executing the following command from the ot-node directory: bash tools/local-network-setup/setup-macos-environment.sh --nodes=8

• Once the network deployment is initiated, you will be provided with the local hardhat blockchain and the amount of local DKG nodes that you defined via --nodes flag

Once the network is up and running, you will select one of the local node endpoints to configure the Edge Node services, which will be explained in the continuation of these instructions.

2 - Cloning DKG Edge node services:

In order to kick off the installation process, you need to clone all Edge Node services to your local environment using git clone command.

1. Authentication service

2. Edge Node API

3. Edge Node interface

4. Knowledge mining API

5. dRAG

3 - Configuring DKG Edge node services

The instructions for configuring DKG Edge Node services are also available in the README file of each service's Github repository, where you can follow the steps provided.

3.1 Setup Edge Node Authentication service:

• Create database 'edge-node-auth-service'

• Create .env file with cp .env.example .env in the dir.

• Generate random strings for the following .env variables:

  • JWT_SECRET and

  • SECRET (you can use openssl rand -hex 64 for example)

• Install node modules with npm install (use Node.js v22.4.0)

• Run the following MySQL query on edge-node-auth-service database: UserConfig.sql

• Setup your database with npx sequelize-cli db:migrate and npx sequelize-cli db:seed:all - This will generate demo user, wallet with funds for local network and configure your local Edge Node Authentication service to connect to the first node from your local network.

seed command will create an example user with the following credentials:

username admin and password admin123

• Initiate Edge Node Authentication service with: npm run start

3.2 - Configuring Edge Node API service:

1. Create .env file with cp .env.example .env in the service directory

2. Create database mentioned in .env

3. Install node modules with npm install (use Node.js v22.4.0)

4. Execute migrations: npx sequelize-cli db:migrate

5. Setup Runtime node MySQL operational db connection by populating the following values in the .env file:

RUNTIME_NODE_OPERATIONAL_DB_USERNAME=root
RUNTIME_NODE_OPERATIONAL_DB_PASSWORD=
RUNTIME_NODE_OPERATIONAL_DB_DATABASE=operationaldb0
RUNTIME_NODE_OPERATIONAL_DB_HOST=127.0.0.1
RUNTIME_NODE_OPERATIONAL_DB_DIALECT=mysql

When your local DKG network is deployed, each of the local nodes will create its own operational database named operationaldb0, operationaldb1, operationaldb2, and so on, depending on the size of your local network.

1. Initialize Redis and make sure that its running on it's default port 6379

2. Start the service: npm run start

3.3 - Configuring Edge Node UI:

In order to setup the Edge node UI locally, please run the following commands:

• Create .env file: cp .env.example .env

• Install ionic/cli: npm install -g @ionic/cli

• Install electron: npm install -g electron

• Install node modules: npm install (use Node.js v22.4.0)

• To run the application in browser: ionic serve

• To run the application in desktop app: npm run start-electron

Once the Edge node UI is ready,the only accessible screen will be /login. Use the credentials created during the Auth service setup previously.

3.4 - Configuring Edge Node Knowledge mining:

In order to setup Edge node UI locally, please follow the steps below:

• Create .env file with cp .env.example .env in the dir.

• Add the absolute path to your DAGs folder into the DAG_FOLDER_NAME variable in the .env file

• Setup Python environment: pyenv local 3.11.7

It's recommended to use pyenv and install Python 3.11 locally within the app's directory to avoid conflicts with other Python versions on your machine.

• A virtual environment should be set up to install the required dependencies. You can do this by running the following command: python -m venv .venv && source .venv/bin/activate

• Install Python requirements: pip install -r requirements.txt

• Setup Apache Airflow service:

Airflow pipelines are an integral part of the Knowledge Mining service, used to create automated data processing workflows. The primary purpose of these pipelines is to generate content for Knowledge Assets based on input files.

• Generate default airflow config: airflow config list --defaults

• Open the Airflow configuration file located at "~/airflow/airflow.cfg" file and update the following parameters as presented below:

load_examples = False
dags_folder = YOUR_PATH_TO/edge-node-knowledge-mining/dags
parallelism = 32
max_active_tasks_per_dag = 16
max_active_runs_per_dag = 16
enable_xcom_pickling = True

• Initiate Airflow database and create admin user with:

airflow db init
airflow users  create --role Admin --username admin --email admin --firstname admin --lastname admin --password admin

• Initiate Airflow scheduler: airflow scheduler

• Pick up new jobs and start them:

airflow dags unpause exampleDAG
airflow dags unpause pdf_to_jsonld
airflow dags unpause simple_json_to_jsonld

• Initiate Airflow webserver: airflow webserver --port 8080

• Once the Airflow webserver is initiated, your pipelines should be awailable on http://localhost:8080/home

• Initiate Edge node Knowledge mining: python app.py

airflow scheduler, airflow webserver and python app.py should be initiated in parallel inside the virtual environment (use separated terminal windows to run them).

• Create MySQL logging: CREATE DATABASE `ka-mining-api-logging` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

Edge node Knowledge Mining README is available here.

3.5 - Configuring Edge Node dRAG:

In order to setup Edge Node dRAG locally, please follow the steps below:

• Install node modules: npm install (use Node.js v22.4.0)

• Create .env file: cp .env.example .env

• Add your LLM_API_KEY into the .env (dRAG uses LLM to formulate the answer)

• Create a database for dRAG logging: CREATE DATABASE drag_logging;

• Run migrations: npx sequelize-cli db:migrate

• Initiate the service: npm run start

(Optional) In case you want to use the vectorization controller, you have to set up the following services: HuggingFace, Zilliz and Cohere. If you want to customize the experience further, you can also modify the code to use any other service for embedding/vector search and reranking.

• HuggingFace - used for vectorization embedding model https://huggingface.co/

• Zilliz - used for hosting the vector database https://cloud.zilliz.com/

• Cohere ReRanker - used for improving retrieval results accuracy https://dashboard.cohere.com/

Once you've finalized configuring of all DKG Edge node services, please make sure that they are exposed on the following ports:

• Edge Node Authentication service: http://localhost:3001

• Edge Node API: http://localhost:3002

• Edge Node UI: http://localhost:5173

• Edge Node Knowledge mining: http://localhost:5005

• Edge Node dRAG: http://localhost:5002

Setup with pre-deployed V8 DKG Runtime testnet node

Prior to proceeding with this setup option, it is essential to have a V8 DKG Core Node operational on the testnet, as this is a critical requirement. If you have not yet deployed a Testnet Core Node, please consult the installation guide available on the following page for detailed instructions.

System Requirements

• Operating System: macOS, Linux, Windows with WSL

• RAM: At least 8 GB

• CPU: 4

• Storage: At least 20 GB available space

• Network: Stable internet connection

Software Dependencies

Make sure the following services are installed and properly configured:

• Git: Version control system

• MySQL 8: Database service

• Redis: In-memory data structure store (documentation)

• Node.js v22.4.0: JavaScript runtime environment

• Python v3.11.7

We recommend using NVM and Pyenv in order to be able to switch Node.js versions easily and install Python.

Setup process:

1 - Cloning DKG Edge node services:

In order to kick off the installation process, you need to clone all Edge Node services to your local environment using git clone command.

1. Authentication service

2. Edge Node API

3. Edge Node interface

4. Knowledge mining API

5. dRAG

2 - Whitelisting your local IP on the pre-deployed V8 DKG Runtime node:

• SSH to the server where you have your V8 DKG Core node up and running

• Edit .origintrail_noderc configuration file with nano or any other editor

• Locate the auth section in the configuration file and add you local IP as presented below:

    "auth": {
        "ipWhitelist": [
            "::1",
            "127.0.0.1",
            "<your_local_ip_address>"
        ]
    }

• Restart you node with otnode-restart command in order for changes to configuration to be applied

3 - Configuring DKG Edge node services

The instructions for configuring DKG Edge Node services are also available in the README file of each service's Github repository, where you can follow the steps provided.

3.1 Setup Edge Node Authentication service:

• Create database 'edge-node-auth-service'

• Create .env file with cp .env.example .env in the dir.

• Generate random strings for the following .env variables:

  • JWT_SECRET and

  • SECRET (you can use openssl rand -hex 64 for example)

• Install node modules with npm install (use Node.js v22.4.0)

• Setup your database with npx sequelize-cli db:migrate and npx sequelize-cli db:seed:all - This will generate demo user, wallet with funds for local network and configure your local Edge Node Authentication service to connect to the first node from your local network.

seed command will create an example user with the following credentials:

username admin and password admin123

• Run the following MySQL query on edge-node-auth-service database: UserConfig.sql

• Since the node is by default configuired to automatically wotk with your local network, the following variables inside of the UserConfigs table (database: edge-node-auth-service) should be updated to match your pre-deployed V8 DKG Runtime node information:

  • "run_time_node_endpoint": http://<your_node_endpoint_or_ip>

  • "run_time_node_port": 8900

  • "edge_node_environment": testnet

  • "blockchain": base:84532

• Replace placeholder wallet - The following table "user_wallets" will be populated with pre-defined (local network related) wallet address which should be replaced by your Base Sepolia wallet with funds (ETH and TRAC)

Instructions on how to use TRAC faucet can be found here.

• Initiate Edge Node Authentication service with: npm run start

3.2 - Configuring Edge Node API service:

1. Create .env file with cp .env.example .env in the service directory

2. Create database mentioned in .env

3. Install node modules with npm install (use Node.js v22.4.0)

4. Execute migrations: npx sequelize-cli db:migrate

5. Expose V8 DKG Core node operational database (MySQL) to a local Edge Node API service:

   • SSH to your Runtime node server

   • Expose port 3306 on your server to your local IP address (firewall configuration)

   • Enable MySQL remote connection by changing the bind-address from 127.0.0.0 to 0.0.0.0 in /etc/mysql/mysql.conf.d/mysqld.cnf

   • Restart mysql.service: systemctl restart mysql.service

   • Create new MySQL user for Edge Node API service to use:

     • mysql -u root -p

     • When asked for password, use the password you created during the node setup process

     • Create user for remote access: CREATE USER'username'@'%' IDENTIFIED BY'your_password';

     • GRANT ALL PRIVILEGES ON*.*TO'username'@'%'WITH GRANT OPTION;

     • FLUSH PRIVILEGES;

   • Setup Runtime node MySQL operational db connection by populating the following values in the .env file:

     RUNTIME_NODE_OPERATIONAL_DB_USERNAME=root
     RUNTIME_NODE_OPERATIONAL_DB_PASSWORD=<runtime_node_operationaldb_password>
     RUNTIME_NODE_OPERATIONAL_DB_DATABASE=operationaldb
     RUNTIME_NODE_OPERATIONAL_DB_HOST=<endpoint/ip_of_your_runtime_node>
     RUNTIME_NODE_OPERATIONAL_DB_DIALECT=mysql

6. Initialize Redis and make sure that its running on it's default port 6379

7. Start the service: npm run start

3.3 - Configuring Edge Node UI:

In order to setup the Edge node UI locally, please run the following commands:

• Create .env file: cp .env.example .env

• Install ionic/cli: npm install -g @ionic/cli

• Install electron: npm install -g electron

• Install node modules: npm install (use Node.js v22.4.0)

• To run the application in browser: ionic serve

• To run the application in desktop app: npm run start-electron

Once the Edge node UI is ready, the only accessible screen will be /login. Use the credentials created during the Auth service setup previously.

3.4 - Configuring Edge Node Knowledge mining:

In order to setup Edge node UI locally, please follow the steps below:

• Create .env file with cp .env.example .env in the dir.

• Add the absolute path to your DAGs folder into the DAG_FOLDER_NAME variable in the .env file

• Setup Python environment: pyenv local 3.11.7

It's recommended to use pyenv and install Python 3.11 locally within the app's directory to avoid conflicts with other Python versions on your machine.

• A virtual environment should be set up to install the required dependencies. You can do this by running the following command: python -m venv .venv && source .venv/bin/activate

• Install Python requirements: pip install -r requirements.txt

• Setup Apache Airflow service:

Airflow pipelines are an integral part of the Knowledge Mining service, used to create automated data processing workflows. The primary purpose of these pipelines is to generate content for Knowledge Assets based on input files.

• Generate default airflow config: airflow config list --defaults

• Open the Airflow configuration file located at "~/airflow/airflow.cfg" file and update the following parameters as presented below:

load_examples = False
dags_folder = YOUR_PATH_TO/edge-node-knowledge-mining/dags
parallelism = 32
max_active_tasks_per_dag = 16
max_active_runs_per_dag = 16
enable_xcom_pickling = True

• initiate Airflow database and create admin user with:

airflow db init
airflow users  create --role Admin --username admin --email admin --firstname admin --lastname admin --password admin

• Initiate Airflow scheduler: airflow scheduler

• Pick up new jobs and start them:

airflow dags unpause exampleDAG
airflow dags unpause pdf_to_jsonld
airflow dags unpause simple_json_to_jsonld

• Initiate Airflow webserver: airflow webserver --port 8080

• Once the Airflow webserver is initiated, your pipelines should be awailable on http://localhost:8080/home

• Initiate Edge node Knowledge mining: python app.py

airflow scheduler, airflow webserver and python app.py should be initiated in parallel inside the virtual environment (use separated terminal windows to run them).

• Create MySQL logging: CREATE DATABASE `ka-mining-api-logging` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

3.5 - Configuring Edge Node dRAG:

In order to setup Edge Node dRAG locally, please follow the steps below:

• Install node modules: npm install (use Node.js v22.4.0)

• Create .env file: cp .env.example .env

• Add your LLM_API_KEY into the .env (dRAG uses LLM to formulate the answer)

• Create a database for dRAG logging: CREATE DATABASE drag_logging;

• Run migrations: npx sequelize-cli db:migrate

• Initiate the service: npm run start

(Optional) In case you want to use the vectorization controller, you have to set up the following services: HuggingFace, Zilliz and Cohere. If you want to customize the experience further, you can also modify the code to use any other service for embedding/vector search and reranking.

• HuggingFace - used for vectorization embedding model https://huggingface.co/

• Zilliz - used for hosting the vector database https://cloud.zilliz.com/

• Cohere ReRanker - used for improving retrieval results accuracy https://dashboard.cohere.com/

Once you've finalized configuring of all DKG Edge node services, please make sure that they are exposed on the following ports:

• Edge Node Authentication service: http://localhost:3001

• Edge Node API: http://localhost:3002

• Edge Node UI: http://localhost:5173

• Edge Node Knowledge mining: http://localhost:5005

• Edge Node dRAG: http://localhost:5002

Automated development environment setup

An automated local environment setup will be available soon.