dkg 0.1.0b6__py3-none-any.whl → 1.1.0__py3-none-any.whl

dkg/dataclasses.py

@@ -15,10 +15,13 @@
 # specific language governing permissions and limitations
 # under the License.
 
-from enum import Enum
+from dataclasses import dataclass
+from enum import auto, Enum
 
 import pandas as pd
 
+from dkg.types import AutoStrEnum, AutoStrEnumCapitalize, AutoStrEnumUpperCase
+
 
 class BlockchainResponseDict(dict):
     pass
@@ -34,12 +37,29 @@ class NodeResponseDict(dict):
         return pd.DataFrame(self)
 
 
-class KnowledgeAssetEnumStates(Enum):
-    LATEST = "LATEST"
-    LATEST_FINALIZED = "LATEST_FINALIZED"
+class BidSuggestionRange(AutoStrEnum):
+    LOW = auto()
+    MEDIUM = auto()
+    HIGH = auto()
+    ALL = auto()
+
+
+class KnowledgeAssetEnumStates(AutoStrEnumUpperCase):
+    LATEST = auto()
+    LATEST_FINALIZED = auto()
+
+
+class KnowledgeAssetContentVisibility(AutoStrEnumUpperCase):
+    ALL = auto()
+    PUBLIC = auto()
+    PRIVATE = auto()
+
+
+class ParanetIncentivizationType(AutoStrEnumCapitalize):
+    NEUROWEB = auto()
 
 
-class KnowledgeAssetContentVisibility(Enum):
-    ALL = "ALL"
-    PUBLIC = "PUBLIC"
-    PRIVATE = "PRIVATE"
+@dataclass
+class BaseIncentivesPoolParams:
+    def to_contract_args(self) -> dict:
+        raise NotImplementedError("This method should be overridden in subclasses")

dkg/exceptions.py

@@ -95,7 +95,7 @@ class HTTPRequestMethodNotSupported(DKGException):
 
 class NodeRequestError(DKGException):
     """
-    Raised by Node HTTP Provider if error occured during request.
+    Raised by Node HTTP Provider if error occurred during request.
     """
 
     pass

dkg/main.py

@@ -18,12 +18,13 @@
 from functools import wraps
 
 from dkg.assertion import Assertion
-from dkg.asset import ContentAsset
+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.providers import BlockchainProvider, NodeHTTPProvider
 from dkg.types import UAL, Address, ChecksumAddress
 from dkg.utils.ual import format_ual, parse_ual
@@ -31,7 +32,8 @@ from dkg.utils.ual import format_ual, parse_ual
 
 class DKG(Module):
     assertion: Assertion
-    asset: ContentAsset
+    asset: KnowledgeAsset
+    paranet: Paranet
     network: Network
     node: Node
     graph: Graph
@@ -56,7 +58,8 @@ class DKG(Module):
         self.manager = DefaultRequestManager(node_provider, blockchain_provider)
         modules = {
             "assertion": Assertion(self.manager),
-            "asset": ContentAsset(self.manager),
+            "asset": KnowledgeAsset(self.manager),
+            "paranet": Paranet(self.manager),
             "network": Network(self.manager),
             "node": Node(self.manager),
             "graph": Graph(self.manager),

dkg/method.py

@@ -21,8 +21,11 @@ from typing import TYPE_CHECKING, Any, Generic, Type
 
 from dkg.exceptions import ValidationError
 from dkg.types import TFunc
-from dkg.utils.blockchain_request import (ContractInteraction,
-                                          ContractTransaction, JSONRPCRequest)
+from dkg.utils.blockchain_request import (
+    ContractInteraction,
+    ContractTransaction,
+    JSONRPCRequest,
+)
 from dkg.utils.node_request import NodeCall
 from dkg.utils.string_transformations import snake_to_camel
 
@@ -50,48 +53,21 @@ class Method(Generic[TFunc]):
             case JSONRPCRequest():
                 return {"args": self._validate_and_map(self.action.args, args, kwargs)}
             case ContractInteraction():
+                contract = kwargs.pop("contract", None)
+                if not self.action.contract:
+                    if contract:
+                        self.action.contract = contract
+                    else:
+                        raise ValidationError(
+                            "ContractInteraction requires a 'contract' to be provided"
+                        )
+
                 return {
                     "args": self._validate_and_map(self.action.args, args, kwargs),
                     "state_changing": isinstance(self.action, ContractTransaction),
                 }
             case NodeCall():
-                path_placeholders = re.findall(r"\{([^{}]+)?\}", self.action.path)
-
-                args_in_path = 0
-                path_args = []
-                path_kwargs = {}
-                if len(path_placeholders) > 0:
-                    for placeholder in path_placeholders:
-                        if (placeholder != "") and (placeholder in kwargs.keys()):
-                            path_kwargs[placeholder] = kwargs.pop(placeholder)
-                        else:
-                            if len(args) <= args_in_path:
-                                raise ValidationError(
-                                    "Number of given arguments can't be smaller than "
-                                    "number of path placeholders"
-                                )
-
-                            if placeholder == "":
-                                path_args.append(args[args_in_path])
-                            else:
-                                path_kwargs[placeholder] = args[args_in_path]
-
-                            args_in_path += 1
-
-                return {
-                    "path": self.action.path.format(*path_args, **path_kwargs),
-                    "params": self._validate_and_map(
-                        self.action.params, args[args_in_path:], kwargs
-                    )
-                    if self.action.params
-                    else {},
-                    "data": self._validate_and_map(
-                        self.action.data, args[args_in_path:], kwargs
-                    )
-                    if self.action.data
-                    else {},
-                }
-
+                return self._process_node_call_args(args, kwargs)
             case _:
                 return {}
 
@@ -129,3 +105,43 @@ class Method(Generic[TFunc]):
             )
 
         return processed_args
+
+    def _process_node_call_args(
+        self, args: list[Any], kwargs: dict[str, Any]
+    ) -> dict[str, Any]:
+        path_placeholders = re.findall(r"\{([^{}]+)?\}", self.action.path)
+
+        args_in_path = 0
+        path_args = []
+        path_kwargs = {}
+        if len(path_placeholders) > 0:
+            for placeholder in path_placeholders:
+                if (placeholder != "") and (placeholder in kwargs.keys()):
+                    path_kwargs[placeholder] = kwargs.pop(placeholder)
+                else:
+                    if len(args) <= args_in_path:
+                        raise ValidationError(
+                            "Number of given arguments can't be smaller than "
+                            "number of path placeholders"
+                        )
+
+                    if placeholder == "":
+                        path_args.append(args[args_in_path])
+                    else:
+                        path_kwargs[placeholder] = args[args_in_path]
+
+                    args_in_path += 1
+
+        return {
+            "path": self.action.path.format(*path_args, **path_kwargs),
+            "params": self._validate_and_map(
+                self.action.params, args[args_in_path:], kwargs
+            )
+            if self.action.params
+            else {},
+            "data": self._validate_and_map(
+                self.action.data, args[args_in_path:], kwargs
+            )
+            if self.action.data
+            else {},
+        }

dkg/module.py

@@ -34,6 +34,7 @@ class Module:
             processed_args = method.process_args(*args, **kwargs)
             request_params = asdict(method.action)
             request_params.update(processed_args)
+
             return self.manager.blocking_request(type(method.action), request_params)
 
         return caller

dkg/network.py

@@ -16,6 +16,7 @@
 # under the License.
 
 from dkg.constants import DEFAULT_HASH_FUNCTION_ID
+from dkg.dataclasses import BidSuggestionRange
 from dkg.manager import DefaultRequestManager
 from dkg.method import Method
 from dkg.module import Module
@@ -33,19 +34,28 @@ class Network(Module):
     _get_bid_suggestion = Method(NodeRequest.bid_suggestion)
 
     def get_bid_suggestion(
-        self, public_assertion_id: DataHexStr, size_in_bytes: int, epochs_number: int,
+        self,
+        public_assertion_id: DataHexStr,
+        size_in_bytes: int,
+        epochs_number: int,
+        range: BidSuggestionRange = BidSuggestionRange.LOW,
     ) -> int:
         content_asset_storage_address = self._get_asset_storage_address(
             "ContentAssetStorage"
         )
 
-        return int(
-            self._get_bid_suggestion(
-                self.manager.blockchain_provider.blockchain_id,
-                epochs_number,
-                size_in_bytes,
-                content_asset_storage_address,
-                public_assertion_id,
-                DEFAULT_HASH_FUNCTION_ID,
-            )["bidSuggestion"]
+        response = self._get_bid_suggestion(
+            self.manager.blockchain_provider.blockchain_id,
+            epochs_number,
+            size_in_bytes,
+            content_asset_storage_address,
+            public_assertion_id,
+            DEFAULT_HASH_FUNCTION_ID,
+            range,
+        )
+
+        return (
+            int(response["bidSuggestion"])
+            if range != BidSuggestionRange.ALL
+            else response
         )