Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
u-hubar committed Aug 14, 2023
1 parent fb87b50 commit 439dd62
Show file tree
Hide file tree
Showing 18 changed files with 372 additions and 19 deletions.
310 changes: 291 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,305 @@
# OriginTrail Decentralized Knowledge Graph network node - OT-Node v6
<a name="readme-top"></a>

___

OriginTrail technology is a set of tools and protocols evolving as the semantic layer for Web3, built on the OriginTrail Decentralized Knowledge Graph (DKG). Its function is to empower developers and system integrators utilizing decentralized knowledge exchange supported by emerging standards and DLT networks.
<br />
<div align="center">
<a href="https://github.com/OriginTrail/dkg.py">
<img src="images/banner.gif" alt="OriginTrail Node Banner">
</a>

Version 6 is the latest implementation of OriginTrail Decentralized Knowledge Graph. OriginTrail is currently in the launch procedure.
<h3 align="center"><b>OT-Node</b></h3>

The DKG v6 introduces various improvements to the existing OriginTrail DKG. Among others, it will introduce:
- the Universal Asset Locator (UAL), akin to URLs in Web2
- improved discoverability, performance and semantic powers with the expanding support for semantic technologies such as RDF, OWL, SPARQL, Triple Pattern Fragments, SHACL and others
- numerous performance updates to the protocol & network implementation
<p align="center">
</br>
<a href="https://docs.origintrail.io/">OriginTrail Docs</a>
·
<a href="https://github.com/OriginTrail/ot-node/issues">Report Bug</a>
·
<a href="https://github.com/OriginTrail/ot-node/issues">Request Feature</a>
</p>
</div>

To learn more about OriginTrail v6, check out this blogpost.
</br>

## Contribution
<details open>
<summary>
<b>Table of Contents</b>
</summary>
<ol>
<li>
<a href="#📚-about-the-project">📚 About The Project</a>
<ul>
<li><a href="#what-is-a-decentralized-knowledge-graph">What is a Decentralized Knowledge Graph?</a></li>
<li><a href="#the-origintrail-dkg-architecture">The OriginTrail DKG Architecture</a></li>
<li><a href="#what-is-a-knowledge-asset">What is a Knowledge Asset?</a></li>
</ul>
</li>
<li>
<a href="#🚀-getting-started">🚀 Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#local-network-setup">Local Network Setup</a></li>
<li><a href="#dkg-node-setup">DKG Node Setup</a></li>
</ul>
</li>
<li><a href="#📄-license">📄 License</a></li>
<li><a href="#🤝-contributing">🤝 Contributing</a></li>
<li><a href="#📰-social-media">📰 Social Media</a></li>
</ol>
</details>

OriginTrail software is open source (Apache 2 licence) and open for contributions by anyone. We encourage the developer community to submit [issues](https://github.com/OriginTrail/ot-node/issues) and [pull requests](https://github.com/OriginTrail/ot-node/pulls) for DKG v6 on this repo. Please have the issue/PR name formatted like this for easy navigation: ``` [v6] Issue name goes here ```
___

For a live discussion you are welcome to join the OriginTrail tech community in our [Discord](https://discordapp.com/invite/FCgYk2S)!
<br/>

## Launch procedure
The OriginTrail DKG v6 launch is performed in 3 stages:
- Stage 1 which introduces the new network and data layer. The goal of Stage1 is to verify smooth operation of the v6 network and data layer in a public network environment.
- Stage 2 which introduces the incentivisation layer (smart contracts and TRAC token). Stage 2 immediately kicks in once stage 1 KPIs are stable, which will introduce the incentivisation layer, implemented through smart contracts, opening the doors for token delegation, staking and improving several existing mechanisms
- Stage 3 will be focused on performing the migration from v5 to the v6 mainnet.
## 📚 About The Project

Throughout the stages the OriginTrail community is invited to participate by actively utilizing the v6 network. Each node will be capable of collecting granular network KPI and telemetry data and publishing it to the DKG itself, further utilized by the core developers to improve the DKG implementation and proceed through the launch stages. For that purpose, there will be a designated reward pool that node runners will be able to collect by submitting relevant network utilization data. All node runners will be motivated to test and utilize their nodes in various creative ways, in order to generate as much quality DKG utilization data to be able to collect rewards. The collected data will include performance metrics, collected error information from bugs occurrences and other. More details on the reward pool distribution among all node runners will be available shortly.
<details open>
<summary>

## Node setup instructions
### <b>What is a Decentralized Knowledge Graph?</b>
</summary>

Setup instructions are available in the [official documentation](https://docs.origintrail.io/).
<br/>

<div align="center">
<img src="images/nodes.png" alt="Knowledge Asset" width="200">
</div>

There are many available definitions of a knowledge graph, therefore we will present a simplified one focused on usability, rather than completeness. The purpose of this introduction is not to be a comprehensive guide for knowledge graphs, however it aims to get you started with the basics.

A **Knowledge Graph (KG)** is a complex structure that maps the connections and relationships among various entities - be they physical, digital, event-based, or conceptual. Commonly represented as semantic networks, these graphs are leveraged by major corporations such as [Amazon](http://lunadong.com/talks/PG.pdf), [Google](https://en.wikipedia.org/wiki/Google_Knowledge_Graph), [Uber](https://www.youtube.com/watch?v=r3yMSl5NB_Q), and [IBM](https://www.ibm.com/cloud/learn/knowledge-graph) for a wide array of applications, including search, data integration, knowledge reasoning, recommendation engines, analytics, and diverse facets of machine learning and artificial intelligence.

Key characteristics of knowledge graphs include:

- Prioritization of data connections, treating them as "first-class citizens" within the realm of linked data.
- Designed to accommodate data from diverse sources, supporting a variety of formats.
- Their data models are flexible and easily extendable, ready to adapt to the evolving nature of data and its relationships.

While knowledge graphs are typically deployed within the boundaries of a single organization to capture knowledge from various internal and external sources, we conceptualize them more broadly. We define the **Decentralized Knowledge Graph (DKG)** as a global, open data structure comprised of interlinked knowledge assets, benefiting both organizations and individuals.

Unique attributes of the DKG are:

- Empowerment of decentralized applications (Dapps) with search, integration, analytics, AI, and ML capabilities across a wide range of data sources, including blockchains, IPFS, enterprise systems, web services, and personal devices.
- Elimination of the need for a central authority by leveraging decentralized infrastructure.
- Facilitation of permissionless operations within the public network.
- Utilization of decentralized identity and Verifiable Credentials for access control, enabling references to private data.

This expansive approach enhances accessibility and flexibility, positioning the DKG as a powerful tool in the evolving digital landscape.
</details>

<details open>
<summary>

### <b>The OriginTrail DKG Architecture</b>
</summary>

<br/>

The OriginTrail tech stack is tailored to enable the discoverability, verifiability, and connectivity of physical and digital assets in a coherent Web3 data ecosystem. It meets two fundamental requirements for such an infrastructure:

- Ensuring trust via decentralized consensus.
- Utilizing semantic, verifiable asset data to represent complex real-world relationships and characteristics.

OriginTrail achieves this by incorporating two distinct types of technology into two network layers - Blockchains (trust networks) and Knowledge Graphs (semantic data networks).

<div align="center">
<img src="images/dkg-architecture1.png" alt="DKG Architecture" width="400">
</div>

**The DKG layer (Layer 2) consists of multiple sub-layers:**

- **Consensus layer**: Implements interfaces to several blockchains hosting trusted smart contracts used to manage relations between the nodes and implement trustless protocols.
- **Network layer**: A peer-to-peer swarm of DKG nodes hosted by individuals and organizations.
- **Data layer**: Hosting the knowledge graph data, distributed across the network in separate instances of graph databases.
- **Service layer**: Implements various core & extended services like authentication, standard interfaces, and data pipelines.
- **Application layer**: Includes Dapps and traditional applications that utilize the OriginTrail DKG as part of their data flows.

<div align="center">
<img src="images/dkg-architecture2.png" alt="DKG Architecture" width="400">
</div>

Further, the architecture differentiates between **the public, replicated knowledge graph** shared by all network nodes according to the protocol, and **private graphs** hosted separately by each of the networked nodes.

**The OriginTrail DKG** - combining blockchain and knowledge graph technologies - forms the backbone of the new, trusted Web3 data ecosystem. If you're a developer, you can use it to create, maintain, and use Knowledge Assets across Web3 applications, implementing standardized technologies like GS1 EPCIS, RDF/SPARQL, JSON-LD, and other W3C and GS1 standards right out of the box.
</details>

<details open>
<summary>

### <b>What is a Knowledge Asset?</b>
</summary>

<br/>

<div align="center">
<img src="images/ka.png" alt="Knowledge Asset" width="200">
</div>

**Knowledge Asset is the new, AI‑ready resource for the Internet**

Knowledge Assets are verifiable containers of structured knowledge that live on the OriginTrail DKG and provide:
- **Discoverability - UAL is the new URL**. Consider Uniform Asset Locators (UALs) a kind of URL that identify a piece of knowledge and make it easy to find and connect with other Knowledge Assets.
- **Ownership - NFTs enable ownership**. Each Knowledge Asset is created with an NFT token that enables trusted ownership and verifiability of your knowledge.
- **Verifiability - On-chain information trail**. The blockchain tech increases trust, security, transparency, and the traceability of information.

<br/>

**Discover Knowledge Assets with the DKG Explorer:**
<div align="center">
<table>
<tr>
<td align="center">
<a href="https://dkg.origintrail.io/explore?ual=did:dkg:otp/0x5cac41237127f94c2d21dae0b14bfefa99880630/309100">
<img src="images/knowledge-assets-graph1.svg" width="300" alt="Knowledge Assets Graph 1">
</a>
<br><b>Supply Chains</b>
</td>
<td align="center">
<a href="https://dkg.origintrail.io/explore?ual=did:dkg:otp/0x5cac41237127f94c2d21dae0b14bfefa99880630/309285">
<img src="images/knowledge-assets-graph2.svg" width="300" alt="Knowledge Assets Graph 2">
</a>
<br><b>Construction</b>
</td>
<td align="center">
<a href="https://dkg.origintrail.io/explore?ual=did:dkg:otp/0x5cac41237127f94c2d21dae0b14bfefa99880630/309222">
<img src="images/knowledge-assets-graph3.svg" width="300" alt="Knowledge Assets Graph 3">
</a>
<br><b>Life sciences and healthcare</b>
</td>
<td align="center">
<a href="https://dkg.origintrail.io/explore?ual=did:dkg:otp/0x5cac41237127f94c2d21dae0b14bfefa99880630/308028">
<img src="images/knowledge-assets-graph4.svg" width="300" alt="Knowledge Assets Graph 3">
</a>
<br><b>Metaverse</b>
</td>
</tr>
</table>
</div>


</details>

<p align="right">(<a href="#readme-top">back to top</a>)</p>
<br/>

## 🚀 Getting Started

___

### Prerequisites

<br/>

- **NodeJS** >= 16.0.0
- **npm** >= 8.0.0

___
<br/>

### Local Network Setup

<br/>

First, clone the repo:
```bash
git clone https://github.com/OriginTrail/ot-node.git
cd ot-node
```

Install dependencies using `npm`:
```bash
npm install
```

Run the Triple Store.

To use default Triple Store (`blazegraph`), download the exec file and run it with the following command in the separate process:
```bash
java -server -Xmx4g -jar blazegraph.jar
```

Then, depending on the OS, use one of the scripts in order to run the local network with provided number of nodes (minimal amount of nodes should be 12):

**MacOS**
```bash
bash ./tools/local-network-setup/setup-macos-environment.sh --nodes=12
```

**Windows (WSL)**
```bash

```

___
<br/>

### DKG Node Setup

<br/>

In order to run a DKG node on the **Testnet** or **Mainnet**, please read the official documentation: https://docs.origintrail.io/decentralized-knowledge-graph-layer-2/node-setup-instructions/setup-instructions-dockerless

___
<br/>


<br/>
<p align="right">(<a href="#readme-top">back to top</a>)</p>

## 📄 License

Distributed under the Apache-2.0 License. See `LICENSE` file for more information.

<br/>
<p align="right">(<a href="#readme-top">back to top</a>)</p>

## 🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<br/>
<p align="right">(<a href="#readme-top">back to top</a>)</p>

## 📰 Social Media

<br/>

<div align="center">
<a href="https://medium.com/origintrail">
<img src="images/icons/medium.svg" alt="Medium Badge" width="30" style="margin-right: 10px"/>
</a>
<a href="https://t.me/origintrail">
<img src="images/icons/telegram.svg" alt="Telegram Badge" width="30" style="margin-right: 10px"/>
</a>
<a href="https://x.com/origin_trail">
<img src="images/icons/x.svg" alt="X Badge" width="30" style="margin-right: 10px"/>
</a>
<a href="https://www.youtube.com/c/origintrail">
<img src="images/icons/youtube.svg" alt="YouTube Badge" width="30" style="margin-right: 10px"/>
</a>
<a href="https://www.linkedin.com/company/origintrail/">
<img src="images/icons/linkedin.svg" alt="LinkedIn Badge" width="30" style="margin-right: 10px"/>
</a>
<a href="https://discord.gg/cCRPzzmnNT">
<img src="images/icons/discord.svg" alt="Discord Badge" width="30" style="margin-right: 10px"/>
</a>
<a href="https://www.reddit.com/r/OriginTrail/">
<img src="images/icons/reddit.svg" alt="Reddit Badge" width="30" style="margin-right: 10px"/>
</a>
<a href="https://coinmarketcap.com/currencies/origintrail/">
<img src="images/icons/coinmarketcap.svg" alt="Coinmarketcap Badge" width="30" style="margin-right: 10px"/>
</a>
</div>

___
Binary file added images/banner.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dkg-architecture1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dkg-architecture2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions images/icons/coinmarketcap.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions images/icons/discord.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions images/icons/linkedin.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 439dd62

Please sign in to comment.