diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index f8ecbe5a4c..3dad05a1ab 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1 +1 @@ -* @branarakic @djordjekovac @kotlarmilos @NZT48 @zeroxbt +* @branarakic @djordjekovac @NZT48 @zeroxbt @u-hubar diff --git a/README.md b/README.md index 319b9d61cc..c4fd787499 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,285 @@ -# OriginTrail Decentralized Knowledge Graph network node - OT-Node v6 + +___ -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. +
+
+ + OriginTrail Node Banner + -Version 6 is the latest implementation of OriginTrail Decentralized Knowledge Graph. OriginTrail is currently in the launch procedure. +

OT-Node

-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 +

+
+ OriginTrail Docs + Β· + Report Bug + Β· + Request Feature +

+
-To learn more about OriginTrail v6, check out this blogpost. +
-## Contribution +
+ + Table of Contents + +
    +
  1. + πŸ“š About The Project + +
    2. +
  2. + πŸš€ Getting Started + +
    3. +
  3. πŸ“„ License
    4. +
  4. 🀝 Contributing
    5. +
  5. πŸ“° Social Media
    6. +
+
-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)! +
-## 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. +
+ -## Node setup instructions +### **What is the Decentralized Knowledge Graph?** + -Setup instructions are available in the [official documentation](https://docs.origintrail.io/). +
+
+ Knowledge Asset +
+OriginTrail Decentralized Knowledge Graph (DKG), hosted on the OriginTrail Decentralized Network (ODN) as trusted knowledge infrastructure, is shared global Knowledge Graph of Knowledge Assets. Running on the basis of the permissionless multi-chain OriginTrail protocol, it combines blockchains and knowledge graph technology to enable trusted AI applications based on key W3C standards. +
+ +
+ + +### **The OriginTrail DKG Architecture** + + +
+ +The OriginTrail tech stack is a three layer structure, consisting of the multi-chain consensus layer (OriginTrail layer 1, running on multiple blockchains), the Decentralized Knowledge Graph layer (OriginTrail Layer 2, hosted on the ODN) and Trusted Knowledge applications in the application layer. + +
+ DKG Architecture +
+ +Further, the architecture differentiates between **the public, replicated knowledge graph** shared by all network nodes according to the protocol, and **private Knowledge graphs** hosted separately by each of the OriginTrail nodes. + +**Anyone can run an OriginTrail node and become part of the ODN, contributing to the network capacity and hosting the OriginTrail DKG. The OriginTrail node is the ultimate data service for data and knowledge intensive Web3 applications and is used as the key backbone for trusted AI applications (see https://chatdkg.ai)** +
+ +
+ + +### **What is a Knowledge Asset?** + + +
+ +
+ Knowledge Asset +
+ +**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**. Uniform Asset Locators (UALs, based on the W3C Decentralized Identifiers) are a new Web3 knowledge identifier (extensions of the Uniform Resource Locators - URLs) which identify a specific piece of knowledge and make it easy to find and connect with other Knowledge Assets. +- **Ownership - NFTs enable ownership**. Each Knowledge Asset contains an NFT token that enables ownership, knowledge asset administration and market mechanisms. +- **Verifiability - On-chain information origin and verifiable trail**. The blockchain tech increases trust, security, transparency, and the traceability of information. + +By their nature, Knowledge Assets are semantic resources (following the W3C Semantic Web set of standards), and through their symbolic representations inherently AI ready. See more at https://chatdkg.ai +
+ +**Discover Knowledge Assets with the DKG Explorer:** +
+ + + + + + + +
+ + Knowledge Assets Graph 1 + +
Supply Chains + 		+ + Knowledge Assets Graph 2 + +
Construction + 		+ + Knowledge Assets Graph 3 + +
Life sciences and healthcare + 		+ + Knowledge Assets Graph 3 + +
Metaverse +
+
+ + +
+ +

(back to top)

+
+ +## πŸš€ Getting Started + +___ + +### Prerequisites + +
+ +- **NodeJS** >= 16.0.0 +- **npm** >= 8.0.0 + +___ +
+ +### Local Network Setup + +
+ +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 +``` + +___ +
+ +### DKG Node Setup + +
+ +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 + +___ +
+ +### Build on DKG + +
+ +The OriginTrail SDKs are client libraries for your applications, used to interact and connect with the OriginTrail Decentralized Knowledge Graph. +From an architectural standpoint, the SDK libraries are application interfaces into the DKG, enabling you to create and manage Knowledge Assets through your apps, as well as perform network queries (such as search, or SPARQL queries), as illustrated below. + +
+ SDK +
+ +The OriginTrail SDK libraries are being built in various languages by the team and the community, as listed below: +- dkg.js - JavaScript SDK implementation + - [Github repository](https://github.com/OriginTrail/dkg.js) + - [Documentation](https://docs.origintrail.io/decentralized-knowledge-graph-layer-2/dkg-sdk/dkg-v6-js-client) +- dkg.py - Python SDK implementation + - [Github repository](https://github.com/OriginTrail/dkg.py) + - [Documentation](https://docs.origintrail.io/decentralized-knowledge-graph-layer-2/dkg-sdk/dkg-v6-py-client) +___ + +
+

(back to top)

+ +## πŸ“„ License + +Distributed under the Apache-2.0 License. See `LICENSE` file for more information. + +
+

(back to top)

+ +## 🀝 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 + +
+

(back to top)

+ +## πŸ“° Social Media + +
+ +
+ + Medium Badge + + + Telegram Badge + + + X Badge + + + YouTube Badge + + + LinkedIn Badge + + + Discord Badge + + + Reddit Badge + + + Coinmarketcap Badge + +
+ +___ diff --git a/images/banner.gif b/images/banner.gif new file mode 100644 index 0000000000..1157a572ff Binary files /dev/null and b/images/banner.gif differ diff --git a/images/dkg-architecture.png b/images/dkg-architecture.png new file mode 100644 index 0000000000..6d787d8163 Binary files /dev/null and b/images/dkg-architecture.png differ diff --git a/images/icons/coinmarketcap.svg b/images/icons/coinmarketcap.svg new file mode 100644 index 0000000000..30d702d700 --- /dev/null +++ b/images/icons/coinmarketcap.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/images/icons/discord.svg b/images/icons/discord.svg new file mode 100644 index 0000000000..4257d772e3 --- /dev/null +++ b/images/icons/discord.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/images/icons/linkedin.svg b/images/icons/linkedin.svg new file mode 100644 index 0000000000..908c867517 --- /dev/null +++ b/images/icons/linkedin.svg @@ -0,0 +1,4 @@ + + + + diff --git a/images/icons/medium.svg b/images/icons/medium.svg new file mode 100644 index 0000000000..ae6b3edf17 --- /dev/null +++ b/images/icons/medium.svg @@ -0,0 +1,4 @@ + + + + diff --git a/images/icons/reddit.svg b/images/icons/reddit.svg new file mode 100644 index 0000000000..57c919f016 --- /dev/null +++ b/images/icons/reddit.svg @@ -0,0 +1,7 @@ + + + + + + + diff --git a/images/icons/telegram.svg b/images/icons/telegram.svg new file mode 100644 index 0000000000..d52f2e23d4 --- /dev/null +++ b/images/icons/telegram.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/images/icons/x.svg b/images/icons/x.svg new file mode 100644 index 0000000000..17bf45dca1 --- /dev/null +++ b/images/icons/x.svg @@ -0,0 +1,4 @@ + + + + diff --git a/images/icons/youtube.svg b/images/icons/youtube.svg new file mode 100644 index 0000000000..b9324915bf --- /dev/null +++ b/images/icons/youtube.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/images/ka.png b/images/ka.png new file mode 100644 index 0000000000..7381788ab9 Binary files /dev/null and b/images/ka.png differ diff --git a/images/knowledge-assets-graph1.svg b/images/knowledge-assets-graph1.svg new file mode 100644 index 0000000000..bf7d1fe7f1 --- /dev/null +++ b/images/knowledge-assets-graph1.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/images/knowledge-assets-graph2.svg b/images/knowledge-assets-graph2.svg new file mode 100644 index 0000000000..654b0de877 --- /dev/null +++ b/images/knowledge-assets-graph2.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/images/knowledge-assets-graph3.svg b/images/knowledge-assets-graph3.svg new file mode 100644 index 0000000000..4482eba946 --- /dev/null +++ b/images/knowledge-assets-graph3.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/images/knowledge-assets-graph4.svg b/images/knowledge-assets-graph4.svg new file mode 100644 index 0000000000..4f30cddb9f --- /dev/null +++ b/images/knowledge-assets-graph4.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/images/nodes.png b/images/nodes.png new file mode 100644 index 0000000000..fac3e0b4ca Binary files /dev/null and b/images/nodes.png differ diff --git a/images/sdk.png b/images/sdk.png new file mode 100644 index 0000000000..4137e15bb4 Binary files /dev/null and b/images/sdk.png differ