dkg 0.1.0b1__py3-none-any.whl

dkg/module.py

@@ -0,0 +1,63 @@
+# 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 dataclasses import asdict
+from typing import Any, Callable, Sequence
+
+from dkg.exceptions import ValidationError
+from dkg.manager import DefaultRequestManager
+from dkg.method import Method
+from dkg.types import TReturn
+
+
+class Module:
+    manager: DefaultRequestManager
+
+    def retrieve_caller_fn(
+        self, method: Method[Callable[..., TReturn]]
+    ) -> Callable[..., TReturn]:
+        def caller(*args: Any, **kwargs: Any) -> TReturn:
+            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
+
+    def _attach_modules(self, module_definitions: dict[str, Any]) -> None:
+        for module_name, module_info in module_definitions.items():
+            module_info_is_list_like = isinstance(module_info, Sequence)
+
+            module = module_info[0] if module_info_is_list_like else module_info
+
+            if hasattr(self, module_name):
+                raise AttributeError(
+                    f"Cannot set {self} module named '{module_name}'. "
+                    " The dkg object already has an attribute with that name"
+                )
+
+            setattr(self, module_name, module)
+
+            if module_info_is_list_like:
+                if len(module_info) == 2:
+                    submodule_definitions = module_info[1]
+                    module: "Module" = getattr(self, module_name)
+                    module._attach_modules(submodule_definitions)
+                elif len(module_info) != 1:
+                    raise ValidationError(
+                        "Module definitions can only have 1 or 2 elements."
+                    )

dkg/node.py

@@ -0,0 +1,54 @@
+# 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 dkg.dataclasses import NodeResponseDict
+from dkg.manager import DefaultRequestManager
+from dkg.method import Method
+from dkg.module import Module
+from dkg.types import Address, DataHexStr
+from dkg.utils.node_request import NodeRequest
+
+
+class Node(Module):
+    def __init__(self, manager: DefaultRequestManager):
+        self.manager = manager
+
+    _info = Method(NodeRequest.info)
+
+    @property
+    def info(self) -> NodeResponseDict:
+        return self._info()
+
+    _get_bid_suggestion = Method(NodeRequest.bid_suggestion)
+
+    def get_bid_suggestion(
+        self,
+        blockchain: str,
+        epochs_num: int,
+        assertion_size: int,
+        content_asset_storage_address: Address,
+        first_assertion_id: DataHexStr,
+        hash_function_id: int,
+    ) -> NodeResponseDict:
+        return self._get_bid_suggestion(
+            blockchain,
+            epochs_num,
+            assertion_size,
+            content_asset_storage_address,
+            first_assertion_id,
+            hash_function_id,
+        )

dkg/providers/__init__.py

@@ -0,0 +1,2 @@
+from .blockchain import BlockchainProvider  # NOQA
+from .node_http import NodeHTTPProvider  # NOQA

dkg/providers/blockchain.py

@@ -0,0 +1,181 @@
+# 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.
+
+import json
+from collections import namedtuple
+from pathlib import Path
+from typing import Any, Type
+
+from dkg.exceptions import AccountMissing, NetworkNotSupported
+from dkg.types import URI, Address, DataHexStr, Wei
+from eth_account.signers.local import LocalAccount
+from web3 import Web3
+from web3.contract import Contract
+from web3.contract.contract import ContractFunction
+from web3.logs import DISCARD
+from web3.middleware import construct_sign_and_send_raw_middleware
+from web3.types import ABI, ABIFunction, TxReceipt
+from dkg.constants import BLOCKCHAINS
+
+
+class BlockchainProvider:
+    CONTRACTS_METADATA_DIR = Path(__file__).parents[1] / "data/interfaces"
+
+    GAS_BUFFER = 1.2  # 20% gas buffer for estimateGas()
+
+    def __init__(
+        self,
+        rpc_uri: URI,
+        private_key: DataHexStr | None = None,
+        verify: bool = True,
+    ):
+        self.w3 = Web3(Web3.HTTPProvider(rpc_uri, request_kwargs={"verify": verify}))
+
+        if (chain_id := self.w3.eth.chain_id) not in BLOCKCHAINS.keys():
+            raise NetworkNotSupported(
+                f"Network with chain ID {chain_id} isn't supported!"
+            )
+        hub_address: Address = BLOCKCHAINS[chain_id]["hubAddress"]
+
+        self.abi = self._load_abi()
+        self.output_named_tuples = self._generate_output_named_tuples()
+        self.contracts: dict[str, Contract] = {
+            "Hub": self.w3.eth.contract(
+                address=hub_address,
+                abi=self.abi["Hub"],
+            )
+        }
+        self._init_contracts()
+
+        if private_key is not None:
+            self.set_account(private_key)
+
+    def make_json_rpc_request(self, endpoint: str, args: dict[str, Any] = {}) -> Any:
+        web3_method = getattr(self.w3.eth, endpoint)
+
+        if callable(web3_method):
+            return web3_method(**args)
+        else:
+            return web3_method
+
+    def call_function(
+        self,
+        contract: str,
+        function: str,
+        args: dict[str, Any] = {},
+        state_changing: bool = False,
+        gas_price: Wei | None = None,
+        gas_limit: Wei | None = None,
+    ) -> TxReceipt | Any:
+        contract_instance = self.contracts[contract]
+        contract_function: ContractFunction = getattr(
+            contract_instance.functions, function
+        )
+
+        if not state_changing:
+            result = contract_function(**args).call()
+            if function in (output_named_tuples := self.output_named_tuples[contract]):
+                result = output_named_tuples[function](*result)
+            return result
+        else:
+            if not hasattr(self, "account"):
+                raise AccountMissing(
+                    "State-changing transactions can be performed only with specified "
+                    "account."
+                )
+
+            nonce = self.w3.eth.get_transaction_count(self.w3.eth.default_account)
+            gas_price = gas_price if gas_price is not None else self.w3.eth.gas_price
+
+            options = {"nonce": nonce, "gasPrice": gas_price}
+            gas_estimate = contract_function(**args).estimate_gas(options)
+
+            if gas_limit is None:
+                options["gas"] = int(gas_estimate * self.GAS_BUFFER)
+            else:
+                options["gas"] = gas_limit
+
+            tx_hash = contract_function(**args).transact(options)
+            tx_receipt = self.w3.eth.wait_for_transaction_receipt(tx_hash)
+
+            return tx_receipt
+
+    def decode_logs_event(
+        self, receipt: TxReceipt, contract_name: str, event_name: str
+    ) -> Any:
+        return (
+            self.contracts[contract_name]
+            .events[event_name]()
+            .process_receipt(receipt, errors=DISCARD)
+        )
+
+    def set_account(self, private_key: DataHexStr):
+        self.account: LocalAccount = self.w3.eth.account.from_key(private_key)
+        self.w3.middleware_onion.add(
+            construct_sign_and_send_raw_middleware(self.account)
+        )
+        self.w3.eth.default_account = self.account.address
+
+    def _init_contracts(self):
+        for contract in self.abi.keys():
+            if contract == "Hub":
+                continue
+
+            self.contracts[contract] = self.w3.eth.contract(
+                address=(
+                    self.contracts["Hub"]
+                    .functions.getContractAddress(
+                        contract if contract != "ERC20Token" else "Token"
+                    )
+                    .call()
+                    if not contract.endswith("AssetStorage")
+                    else self.contracts["Hub"]
+                    .functions.getAssetStorageAddress(contract)
+                    .call()
+                ),
+                abi=self.abi[contract],
+            )
+
+    def _generate_output_named_tuples(self) -> dict[str, dict[str, Type[tuple]]]:
+        def generate_output_namedtuple(function_abi: ABIFunction) -> Type[tuple] | None:
+            output_names = [output["name"] for output in function_abi["outputs"]]
+            if all(name != "" for name in output_names):
+                return namedtuple(f"{function_abi['name']}Result", output_names)
+            return None
+
+        output_named_tuples = {}
+        for contract_name, contract_abi in self.abi.items():
+            output_named_tuples[contract_name] = {}
+            for item in contract_abi:
+                if (item["type"] != "function") or not item["outputs"]:
+                    continue
+                elif item["name"] in output_named_tuples[contract_name]:
+                    continue
+                named_tuple = generate_output_namedtuple(item)
+                if named_tuple is not None:
+                    output_named_tuples[contract_name][item["name"]] = named_tuple
+
+        return output_named_tuples
+
+    def _load_abi(self) -> ABI:
+        abi = {}
+
+        for contract_metadata in self.CONTRACTS_METADATA_DIR.glob("*.json"):
+            with open(contract_metadata, "r") as metadata_json:
+                abi[contract_metadata.stem] = json.load(metadata_json)
+
+        return abi

dkg/providers/node_http.py

@@ -0,0 +1,62 @@
+# 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 typing import Any
+
+import requests
+from dkg.dataclasses import HTTPRequestMethod, NodeResponseDict
+from dkg.exceptions import HTTPRequestMethodNotSupported, NodeRequestError
+from dkg.types import URI
+from requests import Response
+
+
+class NodeHTTPProvider:
+    def __init__(self, endpoint_uri: URI | str):
+        self.endpoint_uri = URI(endpoint_uri)
+
+    def make_request(
+        self,
+        method: HTTPRequestMethod,
+        path: str,
+        params: dict[str, Any] = {},
+        data: dict[str, Any] = {},
+    ) -> Response:
+        request_func = getattr(self, method.name.lower())
+
+        match method:
+            case HTTPRequestMethod.GET:
+                return request_func(path, params)
+            case HTTPRequestMethod.POST:
+                return request_func(path, data)
+            case HTTPRequestMethod():
+                raise HTTPRequestMethodNotSupported(
+                    f"{method.name} method isn't supported"
+                )
+
+    def get(self, path: str, params: dict[str, Any] = {}) -> NodeResponseDict:
+        try:
+            response = requests.get(f"{self.endpoint_uri}/{path}", params=params)
+            return NodeResponseDict(response.json())
+        except requests.exceptions.HTTPError as err:
+            raise NodeRequestError(err)
+
+    def post(self, path: str, data: dict[str, Any] = {}) -> NodeResponseDict:
+        try:
+            response = requests.post(f"{self.endpoint_uri}/{path}", json=data)
+            return NodeResponseDict(response.json())
+        except requests.exceptions.HTTPError as err:
+            raise NodeRequestError(err)

dkg/types/__init__.py

@@ -0,0 +1,8 @@
+from .blockchain import (ABI, ABIElement, ABIError, ABIEvent,  # NOQA: F401
+                         ABIFunction, ABIParameter, AgreementData)
+from .dkg_node import UAL  # NOQA: F401
+from .encoding import BytesLike, DataHexStr, HexStr  # NOQA: F401
+from .evm import Address, ChecksumAddress, Wei  # NOQA: F401
+from .generics import TFunc, TReturn  # NOQA: F401
+from .network import URI  # NOQA: F401
+from .rdf import JSONLD, NQuads  # NOQA: F401

dkg/types/blockchain.py

@@ -0,0 +1,58 @@
+# 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 typing import NamedTuple, TypedDict
+
+
+class ABIParameter(TypedDict, total=False):
+    name: str
+    type: str
+    indexed: bool | None  # Only used in event inputs
+    components: list["ABIParameter"] | None  # Used for tuple types
+
+
+class ABICommon(TypedDict, total=False):
+    type: str
+    name: str | None
+    inputs: list[ABIParameter]
+
+
+class ABIFunction(ABICommon):
+    outputs: list[ABIParameter]
+    stateMutability: str
+
+
+class ABIEvent(ABICommon):
+    anonymous: bool
+
+
+class ABIError(TypedDict):
+    type: str
+    name: str
+    inputs: list[ABIParameter]
+
+
+ABIElement = ABIFunction | ABIEvent | ABIError
+ABI = list[ABIElement]
+
+
+class AgreementData(NamedTuple):
+    startTime: int
+    epochsNumber: int
+    epochLength: int
+    tokensInfo: list[int]
+    scoreFunctionIdAndProofWindowOffsetPerc: list[int]

dkg/types/dkg_node.py

@@ -0,0 +1,20 @@
+# 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 typing import NewType
+
+UAL = NewType("UAL", str)

dkg/types/encoding.py

@@ -0,0 +1,22 @@
+# 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 typing import NewType
+
+HexStr = NewType("HexStr", str)
+DataHexStr = NewType("DataHexStr", str)
+BytesLike = bytes | DataHexStr

dkg/types/evm.py

@@ -0,0 +1,25 @@
+# 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 typing import NewType
+
+from .encoding import DataHexStr
+
+Address = NewType("Address", DataHexStr)
+ChecksumAddress = NewType("ChecksumAddress", DataHexStr)
+
+Wei = NewType("Wei", int)

dkg/types/generics.py

@@ -0,0 +1,21 @@
+# 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 typing import Any, Callable, TypeVar
+
+TFunc = TypeVar("TFunc", bound=Callable[..., Any])
+TReturn = TypeVar("TReturn")

dkg/types/network.py

@@ -0,0 +1,20 @@
+# 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 typing import NewType
+
+URI = NewType("URI", str)

dkg/types/rdf.py

@@ -0,0 +1,21 @@
+# 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 typing import Any
+
+JSONLD = dict[str, Any]
+NQuads = list[str]