dkg.js 6.0.8 → 6.0.10

package/CONTRIBUTIONS

@@ -0,0 +1,35 @@
+# Contributing to dkg.js
+
+We appreciate your interest in contributing to `dkg.js`, the JavaScript SDK for interacting with the OriginTrail Decentralized Knowledge Graph! We welcome contributions from anyone and are grateful for even the smallest of fixes!
+
+## Contributions We Are Looking For
+
+Your help is valuable to us in various ways:
+
+- **Code**: Submit a pull request for open issues or propose a new feature you think would be beneficial to the project.
+- **Bugs**: File bug reports in our issue tracker. Providing details such as the `dkg.js` library version, and traceback messages will help us fix problems faster.
+- **Documentation**: Improve our project's documentation, whether it's more detailed explanations, new usage examples, or clearer function descriptions.
+- **Tests**: Add more tests to increase our project's code coverage and overall reliability.
+- **Reviews**: Review changes made in our ongoing pull requests.
+
+## Getting Started
+
+1. Fork the repository to your own GitHub account.
+2. Clone the repository to your local machine.
+3. Create a new branch for each feature, fix or improvement.
+4. Ensure your code follows the repository style guide.
+5. Ensure your code is well-documented.
+6. Ensure your code is thoroughly tested.
+7. Submit a pull request to the `main` branch.
+
+## Code Review Process
+
+The maintainers of `dkg.js` review each pull request. We may suggest some changes, improvements or alternatives. When the pull request is approved, it will be merged into the main codebase.
+
+## Community
+
+Feel free to ask for help or discuss solutions with us. We appreciate your contributions to our community! You can find the list of social media in the README.
+
+## License
+
+By contributing, you agree that your contributions will be licensed under its Apache-2.0 License.

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2023 OriginTrail
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,70 +1,249 @@
-![](./header.png)
+<a name="readme-top"></a>
 
-# DKG.js
+___
+
+<br />
+<div align="center">
+  <a href="https://github.com/OriginTrail/dkg.js">
+    <img src="images/banner.jpg" alt="JavaScript SDK Banner">
+  </a>
 
-**Javascript library for interaction with the OriginTrail Decentralized Knowledge Graph**
+  <h3 align="center"><b>dkg.js</b></h3>
+
+  <p align="center">
+    JavaScript SDK for interacting with the OriginTrail Decentralized Knowledge Graph
+    </br>
+    <a href="https://docs.origintrail.io/">OriginTrail Docs</a>
+    ·
+    <a href="https://github.com/OriginTrail/dkg.js/examples/demo.js">View Demo</a>
+    ·
+    <a href="https://github.com/OriginTrail/dkg.js/issues">Report Bug</a>
+    ·
+    <a href="https://github.com/OriginTrail/dkg.js/issues">Request Feature</a>
+  </p>
+</div>
+
+</br>
+
+<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-the-decentralized-knowledge-graph">What is the 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="#installation">Installation</a></li>
+      </ul>
+    </li>
+    <li><a href="#📄-license">📄 License</a></li>
+    <li><a href="#🤝-contributing">🤝 Contributing</a></li>
+    <li><a href="#❤️-thanks-to-all-contributors">❤️ Contributors</a></li>
+    <li><a href="#📰-social-media">📰 Social Media</a></li>
+  </ol>
+</details>
+
+___
+
+<br/>
+
+## 📚 About The Project
+
+<details open>
+<summary>
+
+### **What is the Decentralized Knowledge Graph?**
+</summary>
+
+<br/>
+
+<div align="center">
+    <img src="images/nodes.png" alt="Knowledge Asset" width="200">
+</div>
+
+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.
+</details>
+
+<details open>
+<summary>
+
+### **The OriginTrail DKG Architecture**
+</summary>
+
+<br/>
+
+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. 
+
+<div align="center">
+    <img src="images/dkg-architecture.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 Knowledge graphs** hosted separately by each of the OriginTrail nodes.
 
-The official OriginTrail documentation for v6 can be found [here](https://docs.origintrail.io/dkg-v6-upcoming-version/introduction-to-dkg-v6-start-here).
+**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)**
+</details>
 
+<details open>
+<summary>
 
-## Intro - What is a Decentralized Knowledge Graph (DKG)
+### **What is a Knowledge Asset?**
+</summary>
 
+<br/>
 
-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.
+<div align="center">
+    <img src="images/ka.png" alt="Knowledge Asset" width="200">
+</div>
 
-A **knowledge graph (KG)** is a network of entities — physical & digital objects, events or concepts — illustrating the relationship between them (aka a semantic network). KGs are used by major companies 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), [IBM](https://www.ibm.com/cloud/learn/knowledge-graph) etc for various applications: search, data integration, knowledge reasoning, recommendation engines, analytics, machine learning and AI etc.
+**Knowledge Asset is the new, AI‑ready resource for the Internet**
 
-Key characteristics of knowledge graphs:
-* focus on data connections as "first class citizens" (linked data) 
-* designed to ingest data from multiple sources, usually in different formats
-* flexible data model, easily extendable
+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.
 
-Common knowledge graphs however are deployed within the domain of one organization and are designed to capture knowledge from various sources both from within and outside of the organization.
 
-We define **decentralized knowledge graph (DKG)** as a global shared knowledge graph that is designed to benefit organizations and individuals by providing a common infrastructure for data exchange. The DKG:
+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
+<br/>
 
-* Enables Dapps with search, integration, analytics, AI and ML capabilities for any data source: blockchains, IPFS, enterprise systems, web services, personal devices 
-* Removes central authorities (decentralized infrastructure)
-* Enables permissionless PUBLISH and QUERY (public network)
-* Decentralized identity & Verifiable Credentials based access control (references private data)
+**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>
 
-## The OriginTrail DKG Architecture 
 
-The OriginTrail Decentralized Network implements the DKG according to the OriginTrail protocol.
+</details>
 
-It is:
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+<br/>
 
-* **a permissionless network** - anyone can run OriginTrail nodes
-* **a multi-chain data exchange network** - connects to several blockchains (currently Ethereum and xDai with more integrations upcoming such as with Polkadot)
-* **designed for off-chain data exchange using standardized data models** (GS1 & W3C standards and recommendations)
-* **public open source software**
-* **infrastructure for knowledge marketplaces & tenders** - more info [here](https://www.youtube.com/watch?v=4uCxYGRh5fk)
+## 🚀 Getting Started
 
-More information is available on the OriginTrail [website](https://origintrail.io), [official documentation](https://docs.origintrail.io) and [blog](https://medium.com/origintrail).
+___
 
+### Prerequisites
 
-![](https://i.imgur.com/yTNtZE1.png)
+- **Node.js** >= 16.0.0
+- **npm** >= 8.0.0
 
+In order to use in the local environment, make sure to [run the local DKG network](https://github.com/OriginTrail/ot-node?tab=readme-ov-file#local-network-setup).
 
+___
+<br/>
 
-## DKG Client library
+### Installation
 
-This library provides an interface into the OriginTrail Decentralized Knowledge Graph, enabling:
+<br/>
 
-* creating & updating assets on the public DKG
-* network and local querying of information based on topics and identifiers
-* verifying the integrity of queried data
+Install the SDK:
+```bash
+npm install dkg.js
+```
 
-### Documentation & Usage
+Now you can run a demo example file (requires the local DKG network running): 
+```bash
+node examples/demo.js
+```
 
-Start here: [official DKGv6 documentation](https://docs.origintrail.io/dkg-v6-beta/introduction-to-dkg-v6-start-here)
+<br/>
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
+## 📄 License
 
-## Learn more
+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>
+
+## ❤️ Thanks to all Contributors!
+
+<!-- readme: collaborators,contributors/- -start -->
+<!-- readme: collaborators,contributors/- -end -->
+
+<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>
 
-More information can be found on the [official DKGv6 documentation](https://docs.origintrail.io/dkg-v6-upcoming-version/introduction-to-dkg-v6-start-here), [website](https://origintrail.io) and [Github](https://github.com/OriginTrail).
-
-## Get in touch
-
-Get in touch with the OriginTrail tech community through [Discord](https://discordapp.com/invite/FCgYk2S). 
-
-[`#traceon`]()
+___