dkg 8.0.0a3__py3-none-any.whl → 8.0.2__py3-none-any.whl

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/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/clients/__init__.py

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

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/{main.py → 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

dkg/constants.py

@@ -1,3 +1,6 @@
+from enum import Enum, auto
+from dkg.types import AutoStrEnumUpperCase
+
 # 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
@@ -15,10 +18,79 @@
 # specific language governing permissions and limitations
 # under the License.
 
+DEFAULT_CANON_ALGORITHM = "URDNA2015"
+DEFAULT_RDF_FORMAT = "application/n-quads"
+
 PRIVATE_ASSERTION_PREDICATE = (
-    "https://ontology.origintrail.io/dkg/1.0#privateAssertionID"
+    "https://ontology.origintrail.io/dkg/1.0#privateMerkleRoot"
+)
+
+PRIVATE_HASH_SUBJECT_PREFIX = "https://ontology.origintrail.io/dkg/1.0#metadata-hash:"
+
+PRIVATE_RESOURCE_PREDICATE = (
+    "https://ontology.origintrail.io/dkg/1.0#representsPrivateResource"
 )
 
+CHUNK_BYTE_SIZE = 32
+
+MAX_FILE_SIZE = 10000000
+
+
+class DefaultParameters(Enum):
+    ENVIRONMENT: str = "mainnet"
+    PORT: int = 8900
+    FREQUENCY: int = 5
+    MAX_NUMBER_OF_RETRIES: int = 5
+    HASH_FUNCTION_ID: int = 1
+    MIN_NUMBER_OF_FINALIZATION_CONFIRMATION: int = 3
+    IMMUTABLE: bool = False
+    VALIDATE: bool = True
+    OUTPUT_FORMAT: str = "JSON-LD"
+    STATE: None = None
+    INCLUDE_METADATA: bool = False
+    CONTENT_TYPE: str = "all"
+    HANDLE_NOT_MINED_ERROR: bool = False
+    SIMULATE_TXS: bool = False
+    FORCE_REPLACE_TXS: bool = False
+    GAS_LIMIT_MULTIPLIER: int = 1
+    PARANET_UAL: None = None
+    GET_SUBJECT_UAL: bool = False
+    REPOSITORY: str = "dkg"
+
+
+class OutputTypes(Enum):
+    NQUADS: str = "N-QUADS"
+    JSONLD: str = "JSON-LD"
+
+
+class Environments(Enum):
+    DEVELOPMENT: str = "development"
+    DEVNET: str = "devnet"
+    TESTNET: str = "testnet"
+    MAINNET: str = "mainnet"
+
+
+class BlockchainIds(Enum):
+    HARDHAT_1: str = "hardhat1:31337"
+    HARDHAT_2: str = "hardhat2:31337"
+    BASE_DEVNET: str = "base:84532"
+    GNOSIS_DEVNET: str = "gnosis:10200"
+    NEUROWEB_DEVNET: str = "otp:2160"
+    BASE_TESTNET: str = "base:84532"
+    GNOSIS_TESTNET: str = "gnosis:10200"
+    NEUROWEB_TESTNET: str = "otp:20430"
+    BASE_MAINNET: str = "base:8453"
+    GNOSIS_MAINNET: str = "gnosis:100"
+    NEUROWEB_MAINNET: str = "otp:2043"
+
+
+class OperationStatuses(str, Enum):
+    PENDING = "PENDING"
+    COMPLETED = "COMPLETED"
+    FAILED = "FAILED"
+
+
+ZERO_ADDRESS = "0x0000000000000000000000000000000000000000"
 BLOCKCHAINS = {
     "development": {
         "hardhat1:31337": {
@@ -32,20 +104,40 @@ BLOCKCHAINS = {
     },
     "devnet": {
         "base:84532": {
-            "hub": "0xaA849CAC4FA86f6b7484503f3c7a314772AED6d4",
+            "hub": "0xE043daF4cC8ae2c720ef95fc82574a37a429c40A",
             "rpc": "https://sepolia.base.org",
         }
     },
     "testnet": {
         "base:84532": {
-            "hub": "0xCca0eA14540588A09c85cD6A6Fc53eA3A7010692",
+            "hub": "0xf21CE8f8b01548D97DCFb36869f1ccB0814a4e05",
             "rpc": "https://sepolia.base.org",
-        }
+        },
+        "gnosis:10200": {
+            "hub": "0x2c08AC4B630c009F709521e56Ac385A6af70650f",
+            "rpc": "https://rpc.chiadochain.net",
+        },
+        "otp:20430": {
+            "hub": "0xd7d073b560412c6A7F33dD670d323D01061E5DEb",
+            "rpc": "https://lofar-testnet.origin-trail.network",
+        },
+    },
+    "mainnet": {
+        "base:8453": {
+            "hub": "0x99Aa571fD5e681c2D27ee08A7b7989DB02541d13",
+            "rpc": "https://mainnet.base.org",
+        },
+        "gnosis:100": {
+            "hub": "0x882D0BF07F956b1b94BBfe9E77F47c6fc7D4EC8f",
+            "rpc": "https://rpc.gnosischain.com/",
+        },
+        "otp:2043": {
+            "hub": "0x0957e25BD33034948abc28204ddA54b6E1142D6F",
+            "rpc": "https://astrosat-parachain-rpc.origin-trail.network",
+        },
     },
-    "mainnet": {},
 }
 
-DEFAULT_HASH_FUNCTION_ID = 1
 DEFAULT_PROXIMITY_SCORE_FUNCTIONS_PAIR_IDS = {
     "development": {"hardhat1:31337": 2, "hardhat2:31337": 2, "otp:2043": 2},
     "devnet": {
@@ -67,3 +159,22 @@ DEFAULT_PROXIMITY_SCORE_FUNCTIONS_PAIR_IDS = {
 
 PRIVATE_HISTORICAL_REPOSITORY = "privateHistory"
 PRIVATE_CURRENT_REPOSITORY = "privateCurrent"
+
+
+class Operations(Enum):
+    PUBLISH = "publish"
+    GET = "get"
+    QUERY = "query"
+    PUBLISH_PARANET = "publishParanet"
+    FINALITY = "finality"
+
+
+class Status(AutoStrEnumUpperCase):
+    ERROR = auto()
+    NOT_FINALIZED = auto()
+    FINALIZED = auto()
+    NETWORK_ERROR = auto()
+
+
+class ErrorType(AutoStrEnumUpperCase):
+    DKG_CLIENT_ERROR = auto()