DKG Javascript SDK (dkg.js)

https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client
Admin
A Javascript library for building applications that interact with the OriginTrail Decentralized...
Tokens:36,169
Snippets:224
Trust Score:9.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install DKG Python SDK and Set Up Virtual Environment

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/quickstart-test-drive-the-dkg-in-5-mins/quickstart-with-python

This snippet provides the necessary shell commands to set up a Python development environment. It guides users through creating and activating a virtual environment, then installing the `dkg` SDK using `pip`. This setup ensures project dependencies are isolated and managed correctly.

```Shell
# Create a virtual environment
python -m venv env

# Activate virtual environment
# On Mac/Linux:
source env/bin/activate
# On Windows:
env\Scripts\activate

# Install the DKG SDK
pip install dkg
```

--------------------------------

### Configure DKG Edge Node API Service with Node.js

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This snippet details the steps to configure the Edge Node API service, including environment setup, Node.js dependency installation, and database migrations. It also shows how to populate environment variables to establish a connection to the DKG runtime node's operational database and how to start the service.

```Bash
cp .env.example .env
```

```Node.js
npm install
npx sequelize-cli db:migrate
```

```Shell
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
```

```Node.js
npm run start
```

--------------------------------

### Run dRAG Database Migrations and Start Service

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

These commands finalize the setup of the Edge Node dRAG service. `npx sequelize-cli db:migrate` applies any pending database schema changes, and `npm run start` initiates the dRAG service, making it ready for use.

```Shell
npx sequelize-cli db:migrate
```

```Shell
npm run start
```

--------------------------------

### Navigate into ot-node Directory

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/setting-up-your-development-environment

After cloning the repository, use this command to change your current directory to the newly created 'ot-node' folder. All subsequent installation and setup commands should be executed from within this directory.

```bash
cd ot-node
```

--------------------------------

### Deploy Local DKG Network with Bash and Node.js

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This snippet outlines the commands to clone the OriginTrail node engine, switch to the correct development branch, install Node.js dependencies, and start the local DKG network. It also includes the necessary environment variables for the DKG node to connect to local blockchain and database services like Blazegraph and MySQL.

```Bash
git clone https://github.com/OriginTrail/ot-node
cd ot-node && git checkout v8/develop
npm install
```

```Java
java -server -Xmx4g -jar blazegraph.jar
```

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

```Bash
bash tools/local-network-setup/setup-macos-environment.sh --nodes=5
```

--------------------------------

### Run OriginTrail Edge Node Installer Script

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/automated-setup-with-the-installer

Execute this bash command to initiate the Edge Node setup process. The installer will deploy all necessary components, including drag-api, edge-node-auth-service, ka-mining-api, and ot-node, into the edge_node directory. Wait for the script to complete the installation.

```bash
bash edge-node-installer.sh
```

--------------------------------

### Start DKG Local Network on Linux

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/setting-up-your-development-environment

This command executes the Linux-specific setup script to initialize and run a local DKG network with a specified number of node engines (e.g., 5). It's designed for Linux environments to ensure stable operation and requires prerequisites like Blazegraph and MySQL to be running.

```bash
./tools/local-network-setup/setup-linux-environment.sh --nodes=5
```

--------------------------------

### Clone DKG Edge Node Services Repositories

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

To initiate the installation process, clone all required DKG Edge Node services repositories from GitHub to your local environment. This step ensures you have the complete source code for each service component.

```Shell
git clone https://github.com/OriginTrail/edge-node-authentication-service
git clone https://github.com/OriginTrail/edge-node-api
git clone https://github.com/OriginTrail/edge-node-interface
git clone https://github.com/OriginTrail/edge-node-knowledge-mining
git clone https://github.com/OriginTrail/edge-node-drag
```

--------------------------------

### Configure Edge Node Knowledge Mining with Python and Airflow

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This guide details the setup for the Edge Node Knowledge Mining service, which leverages Apache Airflow for automated data processing workflows. It includes steps for Python environment setup using pyenv, virtual environment creation, dependency installation, Airflow configuration, database initialization, and service startup. Python 3.11.7 is recommended.

```Shell
cp .env.example .env
```

```Shell
pyenv local 3.11.7
```

```Shell
python -m venv .venv && source .venv/bin/activate
```

```Shell
pip install -r requirements.txt
```

```Shell
airflow config list --defaults
```

--------------------------------

### Configure Edge Node API Service Environment (Node.js)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This snippet outlines the initial setup for the Edge Node API service, including creating the environment file, installing Node.js dependencies, and running database migrations. It ensures the service is ready for operation.

```Shell
cp .env.example .env
```

```Shell
npm install
```

```Shell
npx sequelize-cli db:migrate
```

--------------------------------

### Configure Edge Node UI Environment (Node.js)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This section provides the commands to set up the Edge Node UI locally. It includes creating the environment file, installing global Ionic and Electron CLIs, and installing project-specific Node.js modules.

```Shell
cp .env.example .env
```

```Shell
npm install -g @ionic/cli
```

```Shell
npm install -g electron
```

```Shell
npm install
```

--------------------------------

### Install Dependencies and Build ElizaOS DKG Agent Project

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/ai-agents/elizaos-dkg-agent

These commands prepare the ElizaOS DKG agent for execution by installing all required project dependencies using pnpm. After dependencies are installed, the project is built, compiling all necessary components. Ensure you have Node.js 23+ and pnpm installed as prerequisites for these commands to run successfully.

```Shell
pnpm install
pnpm run build
```

--------------------------------

### Configure DKG Edge Node Authentication Service with Node.js

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This snippet provides the commands and environment variables required to set up the Edge Node Authentication Service. It covers copying environment files, generating secure secrets for JWT and general use, installing Node.js modules, running database migrations and seeds, and finally starting the service. A MySQL query from 'UserConfig.sql' is also required to configure the demo user and wallet.

```Bash
cp .env.example .env
openssl rand -hex 64
```

```Node.js
npm install
npx sequelize-cli db:migrate
npx sequelize-cli db:seed:all
npm run start
```

--------------------------------

### Checkout v8/develop Branch for ot-node

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/setting-up-your-development-environment

This command switches the repository to the 'v8/develop' branch, which is recommended for development and ensures you are working with the latest stable features. Ensure you are on the correct branch for compatibility and proper functionality.

```bash
git checkout v8/develop
```

--------------------------------

### Start DKG Local Network on macOS

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/setting-up-your-development-environment

This command executes the macOS-specific setup script to initialize and run a local DKG network with a specified number of node engines (e.g., 5). It's designed for macOS environments to ensure stable operation and requires prerequisites like Blazegraph and MySQL to be running.

```bash
bash tools/local-network-setup/setup-macos-environment.sh --nodes=5
```

--------------------------------

### Clone OriginTrail DKG Edge Node Installer Repository

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/automated-setup-with-the-installer

This command initiates the DKG Edge Node setup by cloning the 'edge-node-installer' repository from GitHub. After cloning, it automatically changes the current directory to the newly created 'edge-node-installer' folder, preparing for subsequent configuration steps.

```Shell
git clone https://github.com/OriginTrail/edge-node-installer.git && cd edge-node-installer
```

--------------------------------

### Install Node.js Dependencies for ot-node

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/setting-up-your-development-environment

This command installs all required Node.js packages and dependencies listed in the project's 'package.json' file. It's crucial for the DKG node engine to function correctly and must be run after cloning and changing branches.

```bash
npm install
```

--------------------------------

### Clone OriginTrail Edge Node Installer with Git

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/deploy-your-edge-node-based-project/automated-deployment-with-installer

Clone the OriginTrail Edge Node installer repository from GitHub and navigate into its directory. This command is the initial step to prepare your Linux server for the Edge Node deployment.

```Bash
git clone https://github.com/OriginTrail/edge-node-installer.git && cd edge-node-installer
```

--------------------------------

### Setup DKG Edge Node Authentication Service

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

Configure the DKG Edge Node Authentication Service by creating its database, setting up environment variables, installing Node.js modules, and migrating/seeding the database. Additionally, update critical configuration parameters in the `UserConfigs` table to ensure proper connectivity with your pre-deployed V8 DKG Runtime Node and manage user wallets.

```Shell
cp .env.example .env
```

```Shell
openssl rand -hex 64
```

```Shell
npm install
```

```Shell
npx sequelize-cli db:migrate
npx sequelize-cli db:seed:all
```

```JSON
{
  "run_time_node_endpoint": "http://<your_node_endpoint_or_ip>",
  "run_time_node_port": 8900,
  "edge_node_environment": "testnet",
  "blockchain": "base:84532"
}
```

```Shell
npm run start
```

--------------------------------

### Deploy OriginTrail Edge Node with Installer Script

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/deploy-your-edge-node-based-project/automated-deployment-with-installer

After populating all necessary configuration parameters in the .env file, execute the edge-node-installer script to initiate the deployment process. This installation may take approximately 20-30 minutes and should not be interrupted to ensure successful completion.

```bash
bash edge-node-installer.sh
```

--------------------------------

### Start Apache Airflow Services (Airflow)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

These commands initiate the Apache Airflow scheduler and webserver, which are essential for running and monitoring your data pipelines. The webserver will be accessible via a web browser.

```Shell
airflow scheduler
```

```Shell
airflow webserver --port 8080
```

--------------------------------

### Clone OriginTrail ot-node Repository

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/setting-up-your-development-environment

This command clones the official OriginTrail ot-node repository from GitHub to your local machine. It's the first step to getting the DKG node engine source code, enabling you to set up a local DKG network.

```bash
git clone https://github.com/OriginTrail/ot-node
```

--------------------------------

### Configure Edge Node Knowledge Mining Environment (Python)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This snippet details the initial setup for the Edge Node Knowledge Mining service. It covers creating the environment file, setting the DAGs folder path, and configuring the Python environment using pyenv and a virtual environment.

```Shell
cp .env.example .env
```

```Shell
pyenv local 3.11.7
```

```Shell
python -m venv .venv && source .venv/bin/activate
```

```Shell
pip install -r requirements.txt
```

--------------------------------

### Populate DKG Edge Node .env File with Node.js Script

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/automated-setup-with-the-installer

This command first installs the 'ethers' npm package, a dependency for the setup script. Subsequently, it executes the 'env-setup.js' Node.js script, which automatically generates and populates all required parameters in the '.env' file, including management, operational, and publishing keys, and the node name.

```Shell
npm install ethers && node env-setup.js
```

--------------------------------

### Start Edge Node Knowledge Mining Application (Python)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This command starts the main Edge Node Knowledge Mining application. It should be run in parallel with the Airflow scheduler and webserver, ideally in a separate terminal window within the virtual environment.

```Python
python app.py
```

--------------------------------

### Download and Prepare OriginTrail V8 DKG Core Node Installer

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-core-node/run-a-v8-core-node-on-mainnet/v8-dkg-core-node-installation

This command downloads the 'installer.sh' script to the '/root/' directory and grants it executable permissions. Ensure you are logged in as root before executing this command to prepare for the OriginTrail node installation.

```bash
cd /root/ && curl -k -o installer.sh https://raw.githubusercontent.com/OriginTrail/ot-node/v8/develop/installer/installer.sh && chmod +x installer.sh
```

--------------------------------

### Configure Edge Node dRAG Service

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This section provides instructions for setting up the Edge Node dRAG (Decentralized Retrieval Augmented Generation) service locally. It covers installing Node.js dependencies, configuring environment variables, creating a logging database, running database migrations, and initiating the service. Node.js v22.4.0 is recommended.

```Shell
npm install
```

```Shell
cp .env.example .env
```

--------------------------------

### Create .env Configuration File for Edge Node

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/deploy-your-edge-node-based-project/automated-deployment-with-installer

Create a new `.env` file by copying the provided `.env.example` file. This `.env` file will be used by the automated installer to configure all necessary parameters for your Edge Node deployment.

```Bash
cp .env.example .env
```

--------------------------------

### Start Edge Node Knowledge Mining Application

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This command initiates the main Edge Node Knowledge Mining application. It should be run in parallel with the Airflow scheduler and webserver, ideally in separate terminal windows, to ensure all components of the service are operational.

```Python
python app.py
```

--------------------------------

### Run Edge Node Services in Development Mode with Bash

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/customize-and-build-with-the-edge-node

This Bash script executes the Edge Node installer, which then runs services based on your forked repositories. It's used to start your customized Edge Node setup, particularly on macOS, after configuring your .env file.

```Bash
bash edge-node-installer/run-dev.sh
```

--------------------------------

### Set Up Edge Node dRAG Locally with Node.js and npm

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

Follow these steps to configure and run the Edge Node dRAG service on your local machine. This involves installing Node.js modules, setting up environment variables, creating a database for logging, running migrations, and initiating the service. Node.js v22.4.0 is recommended.

```Shell
npm install
cp .env.example .env
CREATE DATABASE drag_logging;
npx sequelize-cli db:migrate
npm run start
```

--------------------------------

### Manage OriginTrail Edge Node Services with systemd on Linux

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/automated-setup-with-the-installer

This section provides commands to control and monitor the deployed Edge Node services on Linux using systemd. Services like edge-node-api.service and otnode.service can be managed to check status, start, stop, restart, or view logs. These commands are essential for maintaining the operational state of the Edge Node.

```bash
systemctl status <service-name>
systemctl start <service-name>
systemctl stop <service-name>
systemctl restart <service-name>
journalctl -f -u <service-name>
```

--------------------------------

### Configure Edge Node UI with Node.js and Ionic

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This section outlines the process to set up the Edge Node UI locally. It covers creating environment files, installing global dependencies like Ionic CLI and Electron, and running the application in a browser or as a desktop app. Node.js v22.4.0 is recommended.

```Shell
cp .env.example .env
```

```Shell
npm install -g @ionic/cli
```

```Shell
npm install -g electron
```

```Shell
npm install
```

```Shell
ionic serve
```

```Shell
npm run start-electron
```

--------------------------------

### Download and Grant Executable Access to OriginTrail V8 DKG Core Node Installer (Bash)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-core-node/run-a-v8-core-node-on-testnet/v8-dkg-core-node-installation

This command sequence downloads the OriginTrail V8 DKG Core Node installer script (`installer.sh`) to the `/root/` directory and immediately grants it executable permissions. It uses `curl` to fetch the script from GitHub and `chmod` to make it executable, preparing it for the next installation step.

```Bash
cd /root/ && curl -k -o installer.sh https://raw.githubusercontent.com/OriginTrail/ot-node/v8/develop/installer/installer.sh && chmod +x installer.sh
```

--------------------------------

### Start Edge Node API Service (Node.js)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

After all configurations and dependencies are set up, this command initiates the Edge Node API service. Ensure Redis is running on its default port (6379) before starting the service.

```Shell
npm run start
```

--------------------------------

### Create DKG Edge Node .env Configuration File

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/automated-setup-with-the-installer

This command creates the essential '.env' configuration file by copying the provided '.env.example' template. The '.env' file will store all necessary environment variables and parameters for the DKG Edge Node, which will be populated in the next step.

```Shell
cp .env.example .env
```

--------------------------------

### Run DKG AI Character with pnpm

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/ai-agents/elizaos-dkg-agent

Execute the Eliza AI character by running the `pnpm start` command, specifying the path to your character's JSON configuration file. Ensure your character definition is located in the `characters` folder.

```Shell
pnpm start --characters="characters/chatdkg.character.json"
```

--------------------------------

### Manage OriginTrail V8 DKG Core Node Services on Ubuntu

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-core-node/run-a-v8-core-node-on-mainnet/v8-dkg-core-node-installation

These commands provide essential functionalities for managing the OriginTrail node service, including starting, stopping, restarting, viewing logs, and accessing the node's configuration file. They can be used via custom aliases or standard 'systemctl' and 'nano' commands.

```bash
# Starting your node:
otnode-start
systemctl start otnode

# Stopping the node:
otnode-stop
systemctl stop otnode

# Restarting the node:
otnode-restart
systemctl restart otnode

# Showing node logs:
otnode-logs
journalctl -u otnode --output cat -fn 100

# Opening the node config:
otnode-config
nano /root/ot-node/.origintrail_noderc
```

--------------------------------

### Install Redis for DKG Edge Node

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

Commands to install Redis, an in-memory data structure store, on various operating systems. Redis is a required dependency for DKG Edge Node services, facilitating efficient data handling.

```Shell
sudo apt update
sudo apt install redis-server
```

```Shell
brew install redis
```

--------------------------------

### Shell: Execute Python DKG Query Script

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/quickstart-test-drive-the-dkg-in-5-mins/quickstart-with-python

This command executes the Python script 'query_ka.py' to run the SPARQL query against the DKG. Users on Mac/Linux systems might need to use 'python3' instead of 'python' depending on their environment setup.

```Shell
python query_ka.py
```

--------------------------------

### Install DKG.js in NodeJS Applications

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client

Guide to install the DKG.js library via npm for NodeJS applications and how to import it into project files. This method is suitable for server-side or command-line applications.

```Shell
npm install dkg.js@latest
```

```JavaScript
const DKG = require('dkg.js');
```

--------------------------------

### Run OriginTrail Houston DKG Application Locally

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/graveyard/node-setup-instructions/houston-origintrail-node-command-center

Execute `npm run serve` from the project root to start the Houston DKG application in development mode. This command compiles the application and launches a local server, typically making the app accessible at `http://localhost:8080/` in your web browser. Ensure all dependencies are installed first.

```Bash
npm run serve
```

--------------------------------

### Manage OriginTrail V8 DKG Core Node with Bash Commands

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-core-node/run-a-v8-core-node-on-testnet/v8-dkg-core-node-installation

This section provides essential Bash commands for managing the OriginTrail V8 DKG Core Node. These commands facilitate starting, stopping, restarting, viewing logs, and accessing the node's configuration file, offering both custom `otnode-` aliases and standard `systemctl` or `journalctl` alternatives for flexibility.

```Bash
otnode-start
```

```Bash
systemctl start otnode
```

```Bash
otnode-stop
```

```Bash
systemctl stop otnode
```

```Bash
otnode-restart
```

```Bash
systemctl restart otnode
```

```Bash
otnode-logs
```

```Bash
journalctl -u otnode --output cat -fn 100
```

```Bash
otnode-config
```

```Bash
nano /root/ot-node/.origintrail_noderc
```

--------------------------------

### Monitor OriginTrail Edge Node Installation Progress

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/deploy-your-edge-node-based-project/automated-deployment-with-installer

To track the installation progress of your Edge Node, SSH into your server, navigate to the edge-node-installer directory, and run the service-status script. This script provides real-time updates on the current status of each Edge Node service, indicating when they become active.

```bash
bash service-status.sh
```

--------------------------------

### Execute OriginTrail V8 DKG Core Node Installer (Bash)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-core-node/run-a-v8-core-node-on-testnet/v8-dkg-core-node-installation

This command executes the previously downloaded OriginTrail V8 DKG Core Node installer script. It is crucial to run this command directly without `sudo` as specified in the documentation to ensure proper installation and configuration of the node.

```Bash
./installer.sh
```

--------------------------------

### Install Node.js Dependencies for Houston DKG

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/graveyard/node-setup-instructions/houston-origintrail-node-command-center

After cloning the repository, navigate into the `houston-v6` directory and run `npm install`. This command downloads and installs all required Node.js packages defined in the project's `package.json` file. Node.js v16 is a prerequisite for successful installation.

```Bash
cd houston-v6 && npm install
```

--------------------------------

### Create and Migrate Database for Edge Node dRAG

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

These commands are used to set up the database for the Edge Node dRAG service. The first command creates a new database for dRAG logging, and the second command runs Sequelize migrations to apply the necessary schema changes to the database.

```SQL
CREATE DATABASE drag_logging;
```

--------------------------------

### Run Edge Node UI Application (Node.js)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

These commands allow you to run the Edge Node UI either in a web browser or as a desktop application using Electron. Choose the command based on your desired deployment environment.

```Shell
ionic serve
```

```Shell
npm run start-electron
```

--------------------------------

### Configure .env File for DKG Local Network

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/setting-up-your-development-environment

These lines define essential environment variables for the DKG node engine, specifying the development environment and RPC endpoints for two blockchain connections. Create a `.env` file in the `ot-node` directory and add these configurations to enable local network operation.

```plaintext
NODE_ENV=development
RPC_ENDPOINT_BC1=http://127.0.0.1:8545
RPC_ENDPOINT_BC2=http://127.0.0.1:9545
```

--------------------------------

### Configure OriginTrail Edge Node .env Parameters

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/deploy-your-edge-node-based-project/automated-deployment-with-installer

This section details the essential parameters within the `.env` file required to configure your OriginTrail Edge Node installer. These settings control deployment behavior, blockchain interaction, and wallet configurations for publishing Knowledge Assets.

```APIDOC
{
  "type": "Configuration File",
  "name": ".env",
  "description": "Environment variables for OriginTrail Edge Node deployment.",
  "parameters": [
    {
      "name": "deployment_mode",
      "type": "string",
      "description": "Determines how Edge Node services are handled post-installation.",
      "values": [
        {"value": "development", "description": "Installs services as systemd units but does not enable or start them automatically."},
        {"value": "production", "description": "Installs, enables, and starts services as systemd units automatically. Recommended for live environments."}
      ]
    },
    {
      "name": "blockchain_environment",
      "type": "string",
      "description": "Choose the blockchain environment for the Edge Node.",
      "values": [
        {"value": "mainnet", "description": "Production blockchain environment."},
        {"value": "testnet", "description": "Testing blockchain environment."}
      ]
    },
    {
      "name": "default_publish_blockchain",
      "type": "string",
      "description": "Specify the blockchain that will be used for publishing Knowledge Assets.",
      "values": [
        {"value": "neuroweb", "description": "Neuroweb blockchain."},
        {"value": "base", "description": "Base blockchain."},
        {"value": "gnosis", "description": "Gnosis blockchain."}
      ]
    },
    {
      "name": "publishing_keys",
      "type": "object",
      "description": "Public and private key pairs for up to three wallets used for publishing Knowledge Assets. These wallets must be funded with both TRAC token and the native token of the DEFAULT_PUBLISH_BLOCKCHAIN.",
      "properties": [
        {"name": "PUBLISH_WALLET_01_PUBLIC_KEY", "type": "string", "description": "Public key for the first publishing wallet.", "required": true},
        {"name": "PUBLISH_WALLET_01_PRIVATE_KEY", "type": "string", "description": "Private key for the first publishing wallet.", "required": true},
        {"name": "PUBLISH_WALLET_02_PUBLIC_KEY", "type": "string", "description": "Public key for the second publishing wallet.", "required": false},
        {"name": "PUBLISH_WALLET_02_PRIVATE_KEY", "type": "string", "description": "Private key for the second publishing wallet.", "required": false},
        {"name": "PUBLISH_WALLET_03_PUBLIC_KEY", "type": "string", "description": "Public key for the third publishing wallet.", "required": false},
        {"name": "PUBLISH_WALLET_03_PRIVATE_KEY", "type": "string", "description": "Private key for the third publishing wallet.", "required": false}
      ]
    }
  ]
}
```

--------------------------------

### Execute OriginTrail V8 DKG Core Node Installer

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-core-node/run-a-v8-core-node-on-mainnet/v8-dkg-core-node-installation

This command executes the downloaded OriginTrail node installer script. It's crucial to run this command directly without 'sudo' to ensure proper installation and configuration of the node.

```bash
./installer.sh
```

--------------------------------

### Run OriginTrail DKG V8 Data Migration Script

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/useful-resources/previous-updates/dkg-v8.0-update-guidebook/how-to-upgrade-to-v8

Manually run the 'run-data-migration.sh' script after a successful V8 node start. Ensure 'MAIN_DIR' variables in 'run-data-migration.sh' and 'constants.js' are updated if your main directory is not 'root'. This script migrates triples from V6 to V8 repositories.

```Bash
bash run-data-migration.sh
```

--------------------------------

### Initialize Airflow Database and User for Knowledge Mining

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

These commands are essential for setting up the Airflow database and creating an administrative user. The `airflow db init` command initializes the metadata database, and `airflow users create` sets up an admin account for managing Airflow workflows.

```Shell
airflow db init
```

```Shell
airflow users  create --role Admin --username admin --email admin --firstname admin --lastname admin --password admin
```

--------------------------------

### Manage Airflow DAGs and Services for Knowledge Mining

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

These commands initiate the Airflow scheduler and webserver, and unpause specific DAGs to make them active. The scheduler monitors and triggers tasks, while the webserver provides a UI to manage workflows. The DAGs `exampleDAG`, `pdf_to_jsonld`, and `simple_json_to_jsonld` are unpaused to begin processing.

```Shell
airflow scheduler
```

```Shell
airflow dags unpause exampleDAG
```

```Shell
airflow dags unpause pdf_to_jsonld
```

```Shell
airflow dags unpause simple_json_to_jsonld
```

```Shell
airflow webserver --port 8080
```

--------------------------------

### Edge Node Service Endpoints Summary

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This section lists the default local endpoints and ports for the various OriginTrail DKG Edge Node services once they are successfully configured and running. These URLs are used to access the respective services.

```Text
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
```

--------------------------------

### Configure Optional External Services in Edge Node .env

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/automated-setup-with-the-installer

This snippet shows how to configure optional external services like Unstructured.io and HuggingFace by setting their respective API keys and URLs in the Edge Node's .env file. These services enhance functionalities such as PDF parsing and vector search in dRAG pipelines. Ensure you obtain valid API keys from the respective providers.

```bash
# Unstructured.io - can be obtained from https://unstructured.io/api-key-free
# (used by default for parsing PDF documents)
UNSTRUCTURED_API_URL=""

# HuggingFace - can be obtained from https://huggingface.co/settings/tokens
# (used if you use vector search in your dRAG pipeline)
HUGGINGFACE_API_KEY=""
```

--------------------------------

### Create MySQL Logging Database for Knowledge Mining API

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This SQL command creates a dedicated MySQL database for logging purposes within the Knowledge Mining API. It specifies the character set and collation for proper data handling.

```SQL
CREATE DATABASE `ka-mining-api-logging` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
```

--------------------------------

### Manage OriginTrail Edge Node Services using Systemd

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/deploy-your-edge-node-based-project/automated-deployment-with-installer

OriginTrail Edge Node services are deployed as systemd units, allowing for straightforward management. Use the provided systemctl commands to check status, start, stop, restart, or view logs for any of the deployed services. Replace <service-name> with the specific service identifier from the list provided.

```bash
SERVICES:
  - edge-node-api.service
  - auth-service.service
  - ka-mining-api.service
  - drag-api.service.service
  - otnode.service

COMMANDS:
systemctl status <service-name>
systemctl start <service-name>
systemctl stop <service-name>
systemctl restart <service-name>
journalctl -f -u <service-name>
```

--------------------------------

### Specify Custom Edge Node Service Repository URLs

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/deploy-your-edge-node-based-project/automated-deployment-with-installer

This section details how to configure the OriginTrail DKG Edge Node to deploy customized or forked versions of its services. Provide the URLs to your private repositories for knowledge mining, DRAG, API, UI, and authentication services. If no URLs are defined, the installer will use boilerplate services.

```APIDOC
[
  {
    "name": "EDGE_NODE_KNOWLEDGE_MINING_REPO",
    "type": "string",
    "description": "Link to your fork of the knowledge mining service repository."
  },
  {
    "name": "EDGE_NODE_DRAG_REPO",
    "type": "string",
    "description": "Link to your fork of the DRAG service repository."
  },
  {
    "name": "EDGE_NODE_API_REPO",
    "type": "string",
    "description": "Link to your fork of the Edge Node API repository."
  },
  {
    "name": "EDGE_NODE_UI_REPO",
    "type": "string",
    "description": "Link to your fork of the Edge Node user interface repository."
  },
  {
    "name": "EDGE_NODE_AUTH_SERVICE_REPO",
    "type": "string",
    "description": "Link to your fork of the authentication service repository."
  }
]
```

--------------------------------

### Create MySQL Logging Database for Knowledge Mining (MySQL)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This command creates a dedicated MySQL database for logging purposes within the Knowledge Mining API. It ensures that operational logs can be stored and managed effectively.

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

--------------------------------

### Initialize Airflow Database and Admin User (Airflow)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

These commands initialize the Apache Airflow database and create an administrative user. This is a crucial step for managing Airflow DAGs and accessing the web interface.

```Shell
airflow db init
```

```Shell
airflow users create --role Admin --username admin --email admin --firstname admin --lastname admin --password admin
```

--------------------------------

### Install DKG Python SDK with pip

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-py-client

Install the dkg.py library using pip. This command adds the DKG SDK to your Python environment, enabling interaction with the OriginTrail DKG.

```Python
pip install dkg
```

--------------------------------

### Configure Apache Airflow for Knowledge Mining (Airflow)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

These steps configure Apache Airflow, an integral part of the Knowledge Mining service, for automated data processing workflows. It involves generating a default configuration, updating key parameters, and initializing the Airflow database.

```Shell
airflow config list --defaults
```

--------------------------------

### Set OpenAI LLM API Key in .env

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/ai-agents/elizaos-dkg-agent

To integrate an OpenAI Large Language Model, populate the OPENAI_API_KEY variable in your .env file with your obtained API key. This key enables the Eliza agent to interact with OpenAI's services.

```Shell
OPENAI_API_KEY= # obtain the key on https://platform.openai.com/
```

--------------------------------

### Unpause Airflow DAGs for Knowledge Mining (Airflow)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

These commands unpause specific Apache Airflow DAGs, making them available for scheduling and execution within the Knowledge Mining service. Ensure these DAGs are present in your configured DAGs folder.

```Shell
airflow dags unpause exampleDAG
```

```Shell
airflow dags unpause pdf_to_jsonld
```

```Shell
airflow dags unpause simple_json_to_jsonld
```

--------------------------------

### Install DKG.js for Browser Environments

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client

Instructions to build the DKG.js library for browser environments and how to include it in an HTML file. It highlights the dependency on the web3.js library, which must also be included.

```Shell
npm run build
```

```HTML
<script src='https://cdn.jsdelivr.net/npm/web3@latest/dist/web3.min.js'></script>
<script src='./dist/dkg.min.js'></script>
<script>
   window.addEventListener('load', async function () {
       // DKG object is available here
   });
</script>
```

--------------------------------

### DKG.js Node.js and npm Prerequisites

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client

Details the minimum required versions for Node.js and npm to ensure compatibility with the DKG Javascript SDK. These versions are essential for successful installation and operation of the library.

```Text
node ≥ 20.0.0
npm ≥ 8.0.0
```

--------------------------------

### Clone Elizagraph Repository for ElizaOS DKG Agent

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/ai-agents/elizaos-dkg-agent

This command initializes your ElizaOS DKG agent project by cloning the Elizagraph starter kit from GitHub. It creates a local copy of the repository and then changes the current directory to the newly cloned project folder. This is the essential first step to begin developing your DKG-integrated AI agent.

```Shell
git clone https://github.com/OriginTrail/elizagraph.git
cd elizagraph
```

--------------------------------

### Update Apache Airflow Configuration File (Airflow)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This configuration block shows the essential parameters to update in the Airflow configuration file (`airflow.cfg`). These settings optimize DAG loading, parallelism, and XCom functionality for the Knowledge Mining pipelines.

```Apache Airflow
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
```

--------------------------------

### Execute Python Script to Publish DKG Asset

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/quickstart-test-drive-the-dkg-in-5-mins/quickstart-with-python

This command line snippet shows how to run the Python script (`publish_ka.py`) that publishes the Knowledge Asset. Users should execute this command in their project's terminal after setting up the environment and creating the script. Depending on the system configuration, `python3` might be required instead of `python`.

```Shell
python publish_ka.py
```

--------------------------------

### Clone OriginTrail Houston DKG Project with Git

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/graveyard/node-setup-instructions/houston-origintrail-node-command-center

This command uses Git to clone the official Houston DKG application repository from GitHub. It's the initial step for local development, providing all necessary source files. Ensure Git is installed and configured on your system before execution.

```Bash
git clone https://github.com/OriginTrail/houston-v6.git
```

--------------------------------

### Configure V8 DKG Runtime Node IP Whitelist

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

Edit the `.origintrail_noderc` configuration file on your V8 DKG Core Node server to whitelist your local IP address. This allows your Edge Node to establish connections. After modifying the configuration, restart the node for the changes to be applied.

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

```Shell
otnode-restart
```

--------------------------------

### Understand DKG Paranet Knowledge Asset UAL Format

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-paranets/deploying-a-dkg-paranet

This example illustrates the Universal Asset Locator (UAL) format for a DKG Paranet Knowledge Asset. The UAL is crucial for uniquely identifying and referencing your paranet profile on the DKG, and is needed for subsequent registration steps.

```plaintext
did:dkg:otp:2043/0x8f678eB0E57ee8A109B295710E23076fA3a443fe/1497611/125
```

--------------------------------

### Configure Apache Airflow for Knowledge Mining

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

This configuration snippet provides the recommended settings for the Apache Airflow `airflow.cfg` file, specifically for the Edge Node Knowledge Mining service. It optimizes DAG loading, parallelism, and XCom pickling for efficient workflow execution. Ensure to replace `YOUR_PATH_TO/edge-node-knowledge-mining/dags` with the actual absolute path to your DAGs folder.

```INI
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
```

--------------------------------

### Initialize DKG.js Client and Connect to Node

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client

Demonstrates how to initialize the DKG client by connecting to an OriginTrail gateway node. This snippet shows configuration for environment, endpoint, port, and blockchain settings, including a check for successful connection.

```JavaScript
const dkg = new DKG({
    environment: ENVIRONMENTS.DEVELOPMENT, // or devnet, testnet, mainnet
    endpoint: 'http://localhost',  // gateway node URI
    port: 8900,
    blockchain: {
        name: BLOCKCHAIN_IDS.HARDHAT_1, // or any other blockchain id
        publicKey: PUBLIC_KEY, // not required in browser, metamask used instead
        privateKey: PRIVATE_KEY, // not required in browser, metamask used instead
    },
});

const nodeInfo = await dkg.node.info();
// if successfully connected, the will return an object indicating the node version
// { 'version': '8.X.X' }
```

--------------------------------

### Publish Knowledge Asset with DKG Python SDK

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/quickstart-test-drive-the-dkg-in-5-mins/quickstart-with-python

This Python script facilitates publishing a defined Knowledge Asset to the OriginTrail Decentralized Knowledge Graph. It initializes the DKG client with node and blockchain providers, then uses the `dkg.asset.create` method to publish the asset content. The script outputs the result, confirming successful publication and providing asset details.

```Python
import json
import time

from dkg import DKG
from dkg.providers import BlockchainProvider, NodeHTTPProvider
from dkg.constants import BlockchainIds

node_provider = NodeHTTPProvider(
    endpoint_uri="https://v6-pegasus-node-02.origin-trail.network:8900",
    api_version="v1",
)

blockchain_provider = BlockchainProvider(
    BlockchainIds.NEUROWEB_TESTNET.value,
)

config = {
    "max_number_of_retries": 300,
    "frequency": 2,
}
dkg = DKG(node_provider, blockchain_provider, config)

content = {
    "public": {
        "@context": "https://www.schema.org",
        "@id": "urn:first-dkg-ka:info:hello-dkg",
        "@type": "CreativeWork",
        "name": "Hello DKG",  # 🎯 Remember this name for querying!
        "description": "My first Knowledge Asset on the Decentralized Knowledge Graph!"
    }
}

print("Publishing Knowledge Asset...")

create_asset_result = dkg.asset.create(content, {
    "epochs_num": 2,
    "minimum_number_of_finalization_confirmations": 3,
    "minimum_number_of_node_replications": 1
})

print("Success! Your Knowledge Asset has been published:")
print(json.dumps(create_asset_result, indent=4))
```

--------------------------------

### Install DKG Python SDK with pipx

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-py-client

Install the dkg.py library using pipx. This command installs the DKG SDK in an isolated environment, preventing dependency conflicts with other Python packages.

```Python
pipx install dkg
```

--------------------------------

### Query DKG Knowledge Asset with Python SDK

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/quickstart-test-drive-the-dkg-in-5-mins

This Python snippet demonstrates how to query the Decentralized Knowledge Graph (DKG) using the DKG SDK. It constructs a SPARQL query to select Knowledge Assets based on their name and description. The result of the query operation is then printed in JSON format.

```Python
query_operation_result = dkg.graph.query(
    """
    PREFIX schema: <http://schema.org/>
    SELECT ?s ?name ?description
    WHERE {
        ?s schema:name ?name ;
           schema:description ?description .
    }
    """
)
print_json(query_operation_result)
```

--------------------------------

### Python DKG SDK: Query Knowledge Asset with SPARQL

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/quickstart-test-drive-the-dkg-in-5-mins/quickstart-with-python

This Python script demonstrates how to query and retrieve a published Knowledge Asset from the DKG using the DKG SDK. It connects to a DKG node and blockchain provider, then executes a SPARQL query to find assets by name. Ensure the 'hello dkg' filter matches the name used during publication.

```Python
import json
import os
from dkg import DKG
from dkg.providers import BlockchainProvider, NodeHTTPProvider
from dkg.constants import BlockchainIds

node_provider = NodeHTTPProvider(
    endpoint_uri="https://v6-pegasus-node-02.origin-trail.network:8900",
    api_version="v1",
)

blockchain_provider = BlockchainProvider(
    BlockchainIds.NEUROWEB_TESTNET.value,
)

config = {
    "max_number_of_retries": 300,
    "frequency": 2,
}

dkg = DKG(node_provider, blockchain_provider, config)

# ⚠️ IMPORTANT: Update "hello dkg" if you changed the name when publishing!
query = '''
    PREFIX schema: <http://schema.org/>
    SELECT ?s ?name ?description
    WHERE {
        ?s schema:name ?name ;
           schema:description ?description .
        FILTER(LCASE(?name) = "hello dkg")
    }
'''

print("Querying for your Knowledge Asset...")

try:
    query_result = dkg.graph.query(query)
    print("Found your Knowledge Asset!")
    print(json.dumps(query_result, indent=4))
except Exception as e:
    print(f"Error querying the asset: {e}")
    print("Tip: Make sure the name in your query matches the name you used when publishing!")
```

--------------------------------

### Integrate Optional Vectorization Services for Edge Node dRAG

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-edge-node/get-started-with-the-edge-node-boilerplate/manual-setup

Enhance dRAG functionality by integrating external services for vectorization, vector database hosting, and re-ranking. These services, such as HuggingFace, Zilliz, and Cohere ReRanker, are optional but improve retrieval accuracy and embedding capabilities. Customization for other services is also possible.

```Text
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/
```

--------------------------------

### Disable OriginTrail Node Logger Service on Ubuntu

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-core-node/run-a-v8-core-node-on-mainnet/v8-dkg-core-node-installation

This command sequence disables and stops the 'otnode-logger.service', preventing it from sending logs to the OriginTrail team. It should be executed on the server once the node installation is finalized.

```bash
systemctl disable otnode-logger.service
systemctl stop otnode-logger.service
```

--------------------------------

### Compile OriginTrail Houston DKG for Production Deployment

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/graveyard/node-setup-instructions/houston-origintrail-node-command-center

Use `npm run build` to compile and minify the Houston DKG application for production purposes. This process optimizes the code for performance and reduces file size, preparing it for deployment to a live environment. This command should be run after all development is complete and dependencies are installed.

```Bash
npm run build
```

--------------------------------

### Verify DKG Paranet Sync Start (Log)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-paranets/syncing-a-dkg-paranet

This log message indicates that your OriginTrail node has successfully started the synchronization process for the specified DKG paranet. Look for this output in your node's logs to confirm the initiation of data syncing.

```Log
Paranet sync: Starting paranet sync for paranet: did:dkg:hardhat2:31337/0x8aafc28174bb6c3bdc7be92f18c2f134e876c05e/1/5
```

--------------------------------

### Example DKG Node Configuration with Paranet Sync (JSON)

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/dkg-paranets/syncing-a-dkg-paranet

This example illustrates how the '.origintrail_noderc' file looks after adding the 'assetSync' configuration. It includes a sample 'auth' section and the newly added 'assetSync' object, demonstrating the file's structure. Ensure to save and restart your node after making changes.

```JSON
...
    "auth": {
        "ipWhitelist": [
            "::1",
            "127.0.0.1"
        ]
    },
    "assetSync": {
        "syncParanets": ["did:dkg:hardhat2:31337/0x8aafc28.../1/5"]
    }
}
```

--------------------------------

### Example DKG Node Blockchain Configuration with Gnosis

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/integrated-blockchains/gnosis-chain/connect-to-gnosis

This example illustrates the complete "blockchain" object within the .origintrail_noderc file after successfully adding the Gnosis Chiado configuration. It demonstrates the correct structure and placement of the "gnosis:10200" entry alongside existing implementations, ensuring proper node operation.

```JSON
...
    "blockchain": {
      "defaultImplementation": "otp:20430",
      "implementation": {
        "otp:20430": {
          "enabled": true,
          "config": {
            "sharesTokenSymbol": "shares_token_symbol",
            "sharesTokenName": "shares_token_name",
            "operatorFee": 5,
            "operationalWallets": [
              {
                "evmAddress": "0x0bf...",
                "privateKey": "0x1e3..."
              }
            ],
            "evmManagementWalletPublicKey": "0xd09..."
          }
        },
        "gnosis:10200": {
          "enabled": true,
          "config": {
            "sharesTokenSymbol": "shares_token_symbol",
            "sharesTokenName": "shares_token_name",
            "operatorFee": 5,
            "rpcEndpoints": [
              "https://archive-rpc.chiado.gnosischain.com/"
            ],
            "operationalWallets": [
              {
                "evmAddress": "0x0bf...",
                "privateKey": "0x1e3..."
              }
            ],
            "evmManagementWalletPublicKey": "0xd09..."
           }
         }
      }
    },
...
```

--------------------------------

### Configure DKG AI Agent Environment Variables

Source: https://docs.origintrail.io/build-with-dkg/dkg-toolkit/dkg-sdk/dkg-v8-js-client/build-with-dkg/dkg-toolkit/ai-agents/elizaos-dkg-agent

This section details the essential environment variables required for the Eliza AI agent. It covers DKG node connection parameters, wallet keys for publishing Knowledge Assets, and blockchain network specification. Proper configuration ensures the agent can interact with the DKG and relevant blockchain networks.

```APIDOC
ENVIRONMENT: string
  - Description: Defines the operational environment (e.g., 'development', 'testnet', 'mainnet').
OT_NODE_HOSTNAME: string
  - Description: Hostname or IP address of the OriginTrail DKG node (e.g., 'http://localhost', 'https://positron.origin-trail.network').
OT_NODE_PORT: number
  - Description: Port used by the DKG node, typically 8900.
PUBLIC_KEY: string
  - Description: Public key of the wallet used to publish Knowledge Assets.
PRIVATE_KEY: string
  - Description: Private key corresponding to the above wallet. Ensure it is kept secure.
BLOCKCHAIN_NAME: string
  - Description: Specifies the blockchain network.
  - Supported Values: 'otp:2043' (NeuroWeb mainnet), 'base:8453' (Base mainnet), 'gnosis:100' (Gnosis mainnet), 'otp:20430' (NeuroWeb testnet), 'base:84532' (Base testnet), 'gnosis:10200' (Gnosis testnet).
OPENAI_API_KEY: string
  - Description: API key for OpenAI LLM. Obtain from https://platform.openai.com/.
X_CREDENTIALS: object
  - Description: Credentials for X (Twitter) authentication.
  - Properties: username (string), password (string), email (string).
  - Alternative: TWITTER_COOKIES (string) - copy cookies from browser.
```
Tokens:
Raw