dkg 8.0.0a3__tar.gz → 8.0.1__tar.gz

{dkg-8.0.0a3 → dkg-8.0.1}/PKG-INFO

@@ -1,22 +1,24 @@
 Metadata-Version: 2.1
 Name: dkg
-Version: 8.0.0a3
+Version: 8.0.1
 Summary: Python library for interacting with the OriginTrail Decentralized Knowledge Graph
 License: Apache-2.0
 Author: Uladzislau Hubar
-Author-email: hubar.uladzislau@gmail.com
+Author-email: hubar.uladzislau@gmail.com>, Zvonimir Sculac <zvonimir.sculac@origin-trail.com
 Requires-Python: >=3.10,<4.0
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: eth-abi (>=5.1.0,<6.0.0)
 Requires-Dist: eth-account (>=0.13.4,<0.14.0)
 Requires-Dist: eth-typing (>=5.0.0,<6.0.0)
 Requires-Dist: hexbytes (>=1.2.1,<2.0.0)
 Requires-Dist: ot-pyld (>=2.1.1,<3.0.0)
 Requires-Dist: pandas (>=2.2.3,<3.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
 Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
 Requires-Dist: rdflib (>=6.3.2,<7.0.0)
 Requires-Dist: web3 (>=7.3.0,<8.0.0)
@@ -24,7 +26,7 @@ Description-Content-Type: text/markdown
 
 <a name="readme-top"></a>
 
-___
+---
 
 <br />
 <div align="center">
@@ -75,7 +77,7 @@ ___
   </ol>
 </details>
 
-___
+---
 
 <br/>
 
@@ -85,6 +87,7 @@ ___
 <summary>
 
 ### **What is the Decentralized Knowledge Graph?**
+
 </summary>
 
 <br/>
@@ -94,17 +97,19 @@ ___
 </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. 
+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">
@@ -112,13 +117,15 @@ The OriginTrail tech stack is a three layer structure, consisting of the multi-c
 
 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)**
+**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>
 
 ### **What is a Knowledge Asset?**
+
 </summary>
 
 <br/>
@@ -130,15 +137,16 @@ Further, the architecture differentiates between **the public, replicated knowle
 **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
 <br/>
 
 **Discover Knowledge Assets with the DKG Explorer:**
+
 <div align="center">
     <table>
         <tr>
@@ -170,7 +178,6 @@ By their nature, Knowledge Assets are semantic resources (following the W3C Sema
     </table>
 </div>
 
-
 </details>
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -178,40 +185,43 @@ By their nature, Knowledge Assets are semantic resources (following the W3C Sema
 
 ## 🚀 Getting Started
 
-___
+---
 
 ### Prerequisites
 
-* python `>=3.10`
-* poetry `>=1.5.1`
-
+- python `>=3.10`
+- poetry `>=1.5.1`
 
 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/>
 
 ### Installation
 
-
 Create virtual environment (you can choose any existing folder this command will create configurations and virtual env for python):
+
 ```bash
 python3 -m venv /path/to/folder
 ```
 
 Inside of previously generated folder you will find activate script in bin folder and run it:
+
 ```bash
 source /path/to/folder/bin/activate
 ```
 
-Install dependencies:
+Install dependencies and configure pre-commit hooks:
+
 ```bash
-poetry install
+make install
 ```
 
 Now you can run a demo example file (you need to have the local DKG network running):
+
 ```bash
-python3 examples/demo.py
+make run-demo
 ```
 
 <br/>
@@ -252,7 +262,6 @@ Don't forget to give the project a star! Thanks again!
 
 - [web3.py](https://github.com/ethereum/web3.py): Basis for this project
 
-
 <br/>
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -287,5 +296,5 @@ Don't forget to give the project a star! Thanks again!
   </a>
 </div>
 
-___
+---
 

{dkg-8.0.0a3 → dkg-8.0.1}/README.md

@@ -1,6 +1,6 @@
 <a name="readme-top"></a>
 
-___
+---
 
 <br />
 <div align="center">
@@ -51,7 +51,7 @@ ___
   </ol>
 </details>
 
-___
+---
 
 <br/>
 
@@ -61,6 +61,7 @@ ___
 <summary>
 
 ### **What is the Decentralized Knowledge Graph?**
+
 </summary>
 
 <br/>
@@ -70,17 +71,19 @@ ___
 </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. 
+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">
@@ -88,13 +91,15 @@ The OriginTrail tech stack is a three layer structure, consisting of the multi-c
 
 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)**
+**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>
 
 ### **What is a Knowledge Asset?**
+
 </summary>
 
 <br/>
@@ -106,15 +111,16 @@ Further, the architecture differentiates between **the public, replicated knowle
 **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
 <br/>
 
 **Discover Knowledge Assets with the DKG Explorer:**
+
 <div align="center">
     <table>
         <tr>
@@ -146,7 +152,6 @@ By their nature, Knowledge Assets are semantic resources (following the W3C Sema
     </table>
 </div>
 
-
 </details>
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -154,40 +159,43 @@ By their nature, Knowledge Assets are semantic resources (following the W3C Sema
 
 ## 🚀 Getting Started
 
-___
+---
 
 ### Prerequisites
 
-* python `>=3.10`
-* poetry `>=1.5.1`
-
+- python `>=3.10`
+- poetry `>=1.5.1`
 
 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/>
 
 ### Installation
 
-
 Create virtual environment (you can choose any existing folder this command will create configurations and virtual env for python):
+
 ```bash
 python3 -m venv /path/to/folder
 ```
 
 Inside of previously generated folder you will find activate script in bin folder and run it:
+
 ```bash
 source /path/to/folder/bin/activate
 ```
 
-Install dependencies:
+Install dependencies and configure pre-commit hooks:
+
 ```bash
-poetry install
+make install
 ```
 
 Now you can run a demo example file (you need to have the local DKG network running):
+
 ```bash
-python3 examples/demo.py
+make run-demo
 ```
 
 <br/>
@@ -228,7 +236,6 @@ Don't forget to give the project a star! Thanks again!
 
 - [web3.py](https://github.com/ethereum/web3.py): Basis for this project
 
-
 <br/>
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -263,4 +270,4 @@ Don't forget to give the project a star! Thanks again!
   </a>
 </div>
 
-___
+---

{dkg-8.0.0a3 → dkg-8.0.1}/dkg/__init__.py

@@ -1,3 +1,3 @@
 from . import providers  # NOQA: F401
 from . import utils  # NOQA: F401
-from .main import DKG  # NOQA: F401
+from .clients import DKG, AsyncDKG  # NOQA: F401

{dkg-8.0.0a3 → dkg-8.0.1}/dkg/assertion.py

@@ -17,8 +17,8 @@
 
 from typing import Literal
 
-from dkg.manager import DefaultRequestManager
-from dkg.module import Module
+from dkg.managers.manager import DefaultRequestManager
+from dkg.modules.module import Module
 from dkg.types import JSONLD, HexStr
 from dkg.utils.merkle import MerkleTree, hash_assertion_with_indexes
 from dkg.utils.metadata import generate_assertion_metadata

dkg-8.0.1/dkg/clients/__init__.py

@@ -0,0 +1,4 @@
+from .dkg import DKG
+from .async_dkg import AsyncDKG
+
+__all__ = ["DKG", "AsyncDKG"]

dkg-8.0.1/dkg/clients/async_dkg.py

@@ -0,0 +1,109 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you 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.
+
+from functools import wraps
+
+
+from dkg.modules.asset.async_asset import AsyncKnowledgeAsset
+from dkg.modules.graph.async_graph import AsyncGraph
+from dkg.managers.async_manager import AsyncRequestManager
+from dkg.modules.async_module import AsyncModule
+from dkg.modules.node.async_node import AsyncNode
+from dkg.types import UAL, Address, ChecksumAddress
+from dkg.utils.ual import format_ual, parse_ual
+from dkg.services.input_service import InputService
+from dkg.providers.blockchain.async_blockchain import AsyncBlockchainProvider
+from dkg.providers.node.async_node_http import AsyncNodeHTTPProvider
+from dkg.services.node_services.async_node_service import AsyncNodeService
+from dkg.services.blockchain_services.async_blockchain_service import (
+    AsyncBlockchainService,
+)
+
+
+class AsyncDKG(AsyncModule):
+    asset: AsyncKnowledgeAsset
+    node: AsyncNode
+    graph: AsyncGraph
+
+    def __init__(
+        self,
+        node_provider: AsyncNodeHTTPProvider,
+        blockchain_provider: AsyncBlockchainProvider,
+        config: dict = {},
+    ):
+        self.manager = AsyncRequestManager(node_provider, blockchain_provider)
+
+        self.initialize_services(config)
+
+        modules = {
+            "asset": AsyncKnowledgeAsset(
+                self.manager,
+                self.input_service,
+                self.node_service,
+                self.blockchain_service,
+            ),
+            "node": AsyncNode(self.manager, self.node_service),
+            "graph": AsyncGraph(self.manager, self.input_service, self.node_service),
+        }
+        self._attach_modules(modules)
+
+        self._setup_backwards_compatibility()
+
+    def _setup_backwards_compatibility(self):
+        # Create async wrapper methods
+        async def graph_get(*args, **kwargs):
+            return await self.asset.get(*args, **kwargs)
+
+        async def graph_create(*args, **kwargs):
+            return await self.asset.create(*args, **kwargs)
+
+        # Attach methods to graph
+        self.graph.get = graph_get
+        self.graph.create = graph_create
+
+    def initialize_services(self, config: dict = {}):
+        self.input_service = InputService(self.manager, config)
+        self.node_service = AsyncNodeService(self.manager)
+        self.blockchain_service = AsyncBlockchainService(self.manager)
+
+    @staticmethod
+    @wraps(format_ual)
+    def format_ual(
+        blockchain: str, contract_address: Address | ChecksumAddress, token_id: int
+    ) -> UAL:
+        return format_ual(blockchain, contract_address, token_id)
+
+    @staticmethod
+    @wraps(parse_ual)
+    def parse_ual(ual: UAL) -> dict[str, str | Address | int]:
+        return parse_ual(ual)
+
+    @property
+    def node_provider(self) -> AsyncNodeHTTPProvider:
+        return self.manager.node_provider
+
+    @node_provider.setter
+    def node_provider(self, node_provider: AsyncNodeHTTPProvider) -> None:
+        self.manager.node_provider = node_provider
+
+    @property
+    def blockchain_provider(self) -> AsyncBlockchainProvider:
+        return self.manager.blockchain_provider
+
+    @blockchain_provider.setter
+    def blockchain_provider(self, blockchain_provider: AsyncBlockchainProvider) -> None:
+        self.manager.blockchain_provider = blockchain_provider

dkg-8.0.0a3/dkg/main.py → dkg-8.0.1/dkg/clients/dkg.py

@@ -18,16 +18,19 @@
 from functools import wraps
 
 from dkg.assertion import Assertion
-from dkg.asset import KnowledgeAsset
-from dkg.graph import Graph
-from dkg.manager import DefaultRequestManager
-from dkg.module import Module
-from dkg.network import Network
-from dkg.node import Node
-from dkg.paranet import Paranet
+from dkg.modules.asset.asset import KnowledgeAsset
+from dkg.modules.graph.graph import Graph
+from dkg.managers.manager import DefaultRequestManager
+from dkg.modules.module import Module
+from dkg.modules.network.network import Network
+from dkg.modules.node.node import Node
+from dkg.modules.paranet.paranet import Paranet
 from dkg.providers import BlockchainProvider, NodeHTTPProvider
 from dkg.types import UAL, Address, ChecksumAddress
 from dkg.utils.ual import format_ual, parse_ual
+from dkg.services.input_service import InputService
+from dkg.services.node_services.node_service import NodeService
+from dkg.services.blockchain_services.blockchain_service import BlockchainService
 
 
 class DKG(Module):
@@ -38,34 +41,52 @@ class DKG(Module):
     node: Node
     graph: Graph
 
-    @staticmethod
-    @wraps(format_ual)
-    def format_ual(
-        blockchain: str, contract_address: Address | ChecksumAddress, token_id: int
-    ) -> UAL:
-        return format_ual(blockchain, contract_address, token_id)
-
-    @staticmethod
-    @wraps(parse_ual)
-    def parse_ual(ual: UAL) -> dict[str, str | Address | int]:
-        return parse_ual(ual)
-
     def __init__(
         self,
         node_provider: NodeHTTPProvider,
         blockchain_provider: BlockchainProvider,
+        config: dict = {},
     ):
         self.manager = DefaultRequestManager(node_provider, blockchain_provider)
+
+        self.initialize_services(config)
+
         modules = {
             "assertion": Assertion(self.manager),
-            "asset": KnowledgeAsset(self.manager),
+            "asset": KnowledgeAsset(
+                self.manager,
+                self.input_service,
+                self.node_service,
+                self.blockchain_service,
+            ),
             "paranet": Paranet(self.manager),
             "network": Network(self.manager),
             "node": Node(self.manager),
-            "graph": Graph(self.manager),
+            "graph": Graph(self.manager, self.input_service, self.node_service),
         }
         self._attach_modules(modules)
 
+        # Backwards compatibility
+        self.graph.get = self.asset.get.__get__(self.asset)
+        self.graph.create = self.asset.create.__get__(self.asset)
+
+    def initialize_services(self, config):
+        self.input_service = InputService(self.manager, config)
+        self.node_service = NodeService(self.manager)
+        self.blockchain_service = BlockchainService(self.manager)
+
+    @staticmethod
+    @wraps(format_ual)
+    def format_ual(
+        blockchain: str, contract_address: Address | ChecksumAddress, token_id: int
+    ) -> UAL:
+        return format_ual(blockchain, contract_address, token_id)
+
+    @staticmethod
+    @wraps(parse_ual)
+    def parse_ual(ual: UAL) -> dict[str, str | Address | int]:
+        return parse_ual(ual)
+
     @property
     def node_provider(self) -> NodeHTTPProvider:
         return self.manager.node_provider