dkg 0.1.0b2__tar.gz → 0.1.0b4__tar.gz

{dkg-0.1.0b2 → dkg-0.1.0b4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dkg
-Version: 0.1.0b2
+Version: 0.1.0b4
 Summary: Python library for interacting with the OriginTrail Decentralized Knowledge Graph
 License: Apache-2.0
 Author: Uladzislau Hubar

{dkg-0.1.0b2 → dkg-0.1.0b4}/dkg/asset.py

@@ -21,11 +21,10 @@ from typing import Literal, Type
 
 from pyld import jsonld
 from web3 import Web3
-from web3.constants import HASH_ZERO
+from web3.constants import ADDRESS_ZERO, HASH_ZERO
 from web3.exceptions import ContractLogicError
 
-from dkg.constants import (BLOCKCHAINS, DEFAULT_HASH_FUNCTION_ID,
-                           DEFAULT_SCORE_FUNCTION_ID,
+from dkg.constants import (DEFAULT_HASH_FUNCTION_ID, DEFAULT_SCORE_FUNCTION_ID,
                            PRIVATE_ASSERTION_PREDICATE,
                            PRIVATE_CURRENT_REPOSITORY,
                            PRIVATE_HISTORICAL_REPOSITORY)
@@ -54,6 +53,71 @@ class ContentAsset(Module):
     def __init__(self, manager: DefaultRequestManager):
         self.manager = manager
 
+    _owner = Method(BlockchainRequest.owner_of)
+
+    def is_valid_ual(self, ual: UAL) -> bool:
+        if not ual or not isinstance(ual, str):
+            raise ValueError("UAL must be a non-empty string.")
+
+        parts = ual.split("/")
+        if len(parts) != 3:
+            raise ValueError("UAL format is incorrect.")
+
+        prefixes = parts[0].split(":")
+        prefixes_number = len(prefixes)
+        if prefixes_number != 3 and prefixes_number != 4:
+            raise ValueError("Prefix format in UAL is incorrect.")
+
+        if prefixes[0] != "did":
+            raise ValueError(
+                f"Invalid DID prefix. Expected: 'did'. Received: '{prefixes[0]}'."
+            )
+
+        if prefixes[1] != "dkg":
+            raise ValueError(
+                f"Invalid DKG prefix. Expected: 'dkg'. Received: '{prefixes[1]}'."
+            )
+
+        if prefixes[2] != (
+            blockchain_name := (
+                self.manager.blockchain_provider.blockchain_id.split(":")[0]
+            )
+        ):
+            raise ValueError(
+                "Invalid blockchain name in the UAL prefix. "
+                f"Expected: '{blockchain_name}'. Received: '${prefixes[2]}'."
+            )
+
+        if prefixes_number == 4:
+            chain_id = self.manager.blockchain_provider.blockchain_id.split(":")[1]
+
+            if int(prefixes[3]) != int(chain_id):
+                raise ValueError(
+                    "Chain ID in UAL does not match the blockchain. "
+                    f"Expected: '${chain_id}'. Received: '${prefixes[3]}'."
+                )
+
+        contract_address = self.manager.blockchain_provider.contracts[
+            "ContentAssetStorage"
+        ].address
+
+        if parts[1].lower() != contract_address.lower():
+            raise ValueError(
+                "Contract address in UAL does not match. "
+                f"Expected: '${contract_address.lower()}'. "
+                f"Received: '${parts[1].lower()}'."
+            )
+
+        try:
+            owner = self._owner(int(parts[2]))
+
+            if not owner or owner == ADDRESS_ZERO:
+                raise ValueError("Token does not exist or has no owner.")
+
+            return True
+        except Exception as err:
+            raise ValueError(f"Error fetching asset owner: {err}")
+
     _get_contract_address = Method(BlockchainRequest.get_contract_address)
     _get_current_allowance = Method(BlockchainRequest.allowance)
 
@@ -70,9 +134,7 @@ class ContentAsset(Module):
     _increase_allowance = Method(BlockchainRequest.increase_allowance)
     _decrease_allowance = Method(BlockchainRequest.decrease_allowance)
 
-    def set_allowance(
-        self, token_amount: Wei, spender: Address | None = None
-    ) -> Wei:
+    def set_allowance(self, token_amount: Wei, spender: Address | None = None) -> Wei:
         if spender is None:
             spender = self._get_contract_address("ServiceAgreementV1")
 
@@ -127,6 +189,7 @@ class ContentAsset(Module):
         immutable: bool = False,
         content_type: Literal["JSON-LD", "N-Quads"] = "JSON-LD",
     ) -> dict[str, HexStr | dict[str, str]]:
+        blockchain_id = self.manager.blockchain_provider.blockchain_id
         assertions = format_content(content, content_type)
 
         public_assertion_id = MerkleTree(
@@ -135,7 +198,6 @@ class ContentAsset(Module):
         ).root
         public_assertion_metadata = generate_assertion_metadata(assertions["public"])
 
-        chain_name = BLOCKCHAINS[self._chain_id()]["name"]
         content_asset_storage_address = self._get_asset_storage_address(
             "ContentAssetStorage"
         )
@@ -143,7 +205,7 @@ class ContentAsset(Module):
         if token_amount is None:
             token_amount = int(
                 self._get_bid_suggestion(
-                    chain_name,
+                    blockchain_id,
                     epochs_number,
                     public_assertion_metadata["size"],
                     content_asset_storage_address,
@@ -153,7 +215,7 @@ class ContentAsset(Module):
             )
 
         current_allowance = self.get_current_allowance()
-        if (is_allowance_increased := current_allowance < token_amount):
+        if is_allowance_increased := current_allowance < token_amount:
             self.increase_allowance(token_amount)
 
         try:
@@ -183,7 +245,7 @@ class ContentAsset(Module):
 
         assertions_list = [
             {
-                "blockchain": chain_name,
+                "blockchain": blockchain_id,
                 "contract": content_asset_storage_address,
                 "tokenId": token_id,
                 "assertionId": public_assertion_id,
@@ -195,7 +257,7 @@ class ContentAsset(Module):
         if content.get("private", None):
             assertions_list.append(
                 {
-                    "blockchain": chain_name,
+                    "blockchain": blockchain_id,
                     "contract": content_asset_storage_address,
                     "tokenId": token_id,
                     "assertionId": MerkleTree(
@@ -213,7 +275,7 @@ class ContentAsset(Module):
         operation_id = self._publish(
             public_assertion_id,
             assertions["public"],
-            chain_name,
+            blockchain_id,
             content_asset_storage_address,
             token_id,
             DEFAULT_HASH_FUNCTION_ID,
@@ -221,7 +283,7 @@ class ContentAsset(Module):
         operation_result = self.get_operation_result(operation_id, "publish")
 
         return {
-            "UAL": format_ual(chain_name, content_asset_storage_address, token_id),
+            "UAL": format_ual(blockchain_id, content_asset_storage_address, token_id),
             "publicAssertionId": public_assertion_id,
             "operation": {
                 "operationId": operation_id,
@@ -265,7 +327,8 @@ class ContentAsset(Module):
         content_type: Literal["JSON-LD", "N-Quads"] = "JSON-LD",
     ) -> dict[str, HexStr | dict[str, str]]:
         parsed_ual = parse_ual(ual)
-        content_asset_storage_address, token_id = (
+        blockchain_id, content_asset_storage_address, token_id = (
+            parsed_ual["blockchain"],
             parsed_ual["contract_address"],
             parsed_ual["token_id"],
         )
@@ -278,8 +341,6 @@ class ContentAsset(Module):
         ).root
         public_assertion_metadata = generate_assertion_metadata(assertions["public"])
 
-        chain_name = BLOCKCHAINS[self._chain_id()]["name"]
-
         if token_amount is None:
             agreement_id = self.get_agreement_id(
                 content_asset_storage_address, token_id
@@ -297,7 +358,7 @@ class ContentAsset(Module):
 
             token_amount = int(
                 self._get_bid_suggestion(
-                    chain_name,
+                    blockchain_id,
                     epochs_left,
                     public_assertion_metadata["size"],
                     content_asset_storage_address,
@@ -306,11 +367,11 @@ class ContentAsset(Module):
                 )["bidSuggestion"]
             )
 
-            token_amount -= agreement_data.tokensInfo[0]
+            token_amount -= agreement_data.tokens[0]
             token_amount = token_amount if token_amount > 0 else 0
 
         current_allowance = self.get_current_allowance()
-        if (is_allowance_increased := current_allowance < token_amount):
+        if is_allowance_increased := current_allowance < token_amount:
             self.increase_allowance(token_amount)
 
         try:
@@ -329,7 +390,7 @@ class ContentAsset(Module):
 
         assertions_list = [
             {
-                "blockchain": chain_name,
+                "blockchain": blockchain_id,
                 "contract": content_asset_storage_address,
                 "tokenId": token_id,
                 "assertionId": public_assertion_id,
@@ -341,7 +402,7 @@ class ContentAsset(Module):
         if content.get("private", None):
             assertions_list.append(
                 {
-                    "blockchain": chain_name,
+                    "blockchain": blockchain_id,
                     "contract": content_asset_storage_address,
                     "tokenId": token_id,
                     "assertionId": MerkleTree(
@@ -359,7 +420,7 @@ class ContentAsset(Module):
         operation_id = self._update(
             public_assertion_id,
             assertions["public"],
-            chain_name,
+            blockchain_id,
             content_asset_storage_address,
             token_id,
             DEFAULT_HASH_FUNCTION_ID,
@@ -367,7 +428,7 @@ class ContentAsset(Module):
         operation_result = self.get_operation_result(operation_id, "update")
 
         return {
-            "UAL": format_ual(chain_name, content_asset_storage_address, token_id),
+            "UAL": format_ual(blockchain_id, content_asset_storage_address, token_id),
             "publicAssertionId": public_assertion_id,
             "operation": {
                 "operationId": operation_id,
@@ -638,14 +699,13 @@ class ContentAsset(Module):
         token_amount: Wei | None = None,
     ) -> dict[str, UAL | dict[str, str]]:
         parsed_ual = parse_ual(ual)
-        content_asset_storage_address, token_id = (
+        blockchain_id, content_asset_storage_address, token_id = (
+            parsed_ual["blockchain"],
             parsed_ual["contract_address"],
             parsed_ual["token_id"],
         )
 
         if token_amount is None:
-            chain_name = BLOCKCHAINS[self._chain_id()]["name"]
-
             latest_finalized_state = self._get_latest_assertion_id(token_id)
             latest_finalized_state_size = self._get_assertion_size(
                 latest_finalized_state
@@ -653,7 +713,7 @@ class ContentAsset(Module):
 
             token_amount = int(
                 self._get_bid_suggestion(
-                    chain_name,
+                    blockchain_id,
                     additional_epochs,
                     latest_finalized_state_size,
                     content_asset_storage_address,
@@ -678,14 +738,13 @@ class ContentAsset(Module):
         token_amount: Wei | None = None,
     ) -> dict[str, UAL | dict[str, str]]:
         parsed_ual = parse_ual(ual)
-        content_asset_storage_address, token_id = (
+        blockchain_id, content_asset_storage_address, token_id = (
+            parsed_ual["blockchain"],
             parsed_ual["contract_address"],
             parsed_ual["token_id"],
         )
 
         if token_amount is None:
-            chain_name = BLOCKCHAINS[self._chain_id()]["name"]
-
             agreement_id = self.get_agreement_id(
                 content_asset_storage_address, token_id
             )
@@ -707,7 +766,7 @@ class ContentAsset(Module):
 
             token_amount = int(
                 self._get_bid_suggestion(
-                    chain_name,
+                    blockchain_id,
                     epochs_left,
                     latest_finalized_state_size,
                     content_asset_storage_address,
@@ -738,14 +797,13 @@ class ContentAsset(Module):
         token_amount: Wei | None = None,
     ) -> dict[str, UAL | dict[str, str]]:
         parsed_ual = parse_ual(ual)
-        content_asset_storage_address, token_id = (
+        blockchain_id, content_asset_storage_address, token_id = (
+            parsed_ual["blockchain"],
             parsed_ual["contract_address"],
             parsed_ual["token_id"],
         )
 
         if token_amount is None:
-            chain_name = BLOCKCHAINS[self._chain_id()]["name"]
-
             agreement_id = self.get_agreement_id(
                 content_asset_storage_address, token_id
             )
@@ -765,7 +823,7 @@ class ContentAsset(Module):
 
             token_amount = int(
                 self._get_bid_suggestion(
-                    chain_name,
+                    blockchain_id,
                     epochs_left,
                     unfinalized_state_size,
                     content_asset_storage_address,
@@ -788,8 +846,6 @@ class ContentAsset(Module):
             "operation": {"status": "COMPLETED"},
         }
 
-    _owner = Method(BlockchainRequest.owner_of)
-
     def get_owner(self, ual: UAL) -> Address:
         token_id = parse_ual(ual)["token_id"]
 

dkg-0.1.0b4/dkg/constants.py

@@ -0,0 +1,73 @@
+# 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.
+
+PRIVATE_ASSERTION_PREDICATE = (
+    "https://ontology.origintrail.io/dkg/1.0#privateAssertionID"
+)
+
+BLOCKCHAINS = {
+    "development": {
+        "hardhat1:31337":  {
+            "hub": "0x5FbDB2315678afecb367f032d93F642f64180aa3",
+            "rpc": "http://localhost:8545",
+        },
+        "hardhat2:31337":  {
+            "hub": "0x5FbDB2315678afecb367f032d93F642f64180aa3",
+            "rpc": "http://localhost:9545",
+        },
+        "otp:2043": {
+            "hub": "0x7585a99C5C150a08f5CDeFD16465C6De8D41EbbD",
+            "rpc": "http://parachain-alphanet-02.origin-trail.network:9933",
+        },
+    },
+    "devnet": {
+        "otp:2160": {
+            "hub": "0x833048F6e6BEa78E0AAdedeCd2Dc2231dda443FB",
+            "rpc": "https://lofar-tm-rpc.origin-trail.network",
+        },
+        "gnosis:10200": {
+            "hub": "0xD2bA102A0b11944d00180eE8136208ccF87bC39A",
+            "rpc": "https://rpc.chiadochain.net",
+            "gas_price_oracle": "https://blockscout.chiadochain.net/api/v1/gas-price-oracle",
+        },
+    },
+    "testnet": {
+        "otp:20430": {
+            "hub": "0xBbfF7Ea6b2Addc1f38A0798329e12C08f03750A6",
+            "rpc": "https://lofar-testnet.origin-trail.network",
+        },
+        "gnosis:10200": {
+            "hub": "0xC06210312C9217A0EdF67453618F5eB96668679A",
+            "rpc": "https://rpc.chiadochain.net",
+            "gas_price_oracle": "https://blockscout.chiadochain.net/api/v1/gas-price-oracle",
+        },
+    },
+    "mainnet": {
+        "otp:2043": {
+            "hub": "0x5fA7916c48Fe6D5F1738d12Ad234b78c90B4cAdA",
+            "rpc": "https://astrosat-parachain-rpc.origin-trail.network",
+        },
+    },
+}
+
+DEFAULT_GAS_PRICE_GWEI = 100
+
+DEFAULT_HASH_FUNCTION_ID = 1
+DEFAULT_SCORE_FUNCTION_ID = 1
+
+PRIVATE_HISTORICAL_REPOSITORY = "privateHistory"
+PRIVATE_CURRENT_REPOSITORY = "privateCurrent"

{dkg-0.1.0b2 → dkg-0.1.0b4}/dkg/data/interfaces/Assertion.json

@@ -115,6 +115,32 @@
     "stateMutability": "pure",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "bool",
+        "name": "_status",
+        "type": "bool"
+      }
+    ],
+    "name": "setStatus",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "status",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "version",

{dkg-0.1.0b2 → dkg-0.1.0b4}/dkg/data/interfaces/CommitManagerV1.json

@@ -124,17 +124,6 @@
     "name": "NodeNotInShardingTable",
     "type": "error"
   },
-  {
-    "inputs": [
-      {
-        "internalType": "address",
-        "name": "caller",
-        "type": "address"
-      }
-    ],
-    "name": "OnlyHubOwnerFunction",
-    "type": "error"
-  },
   {
     "inputs": [
       {
@@ -439,6 +428,19 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "bool",
+        "name": "_status",
+        "type": "bool"
+      }
+    ],
+    "name": "setStatus",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "shardingTableStorage",
@@ -478,6 +480,19 @@
     "stateMutability": "view",
     "type": "function"
   },
+  {
+    "inputs": [],
+    "name": "status",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [
       {

{dkg-0.1.0b2 → dkg-0.1.0b4}/dkg/data/interfaces/CommitManagerV1U1.json

@@ -155,17 +155,6 @@
     "name": "NodeNotInShardingTable",
     "type": "error"
   },
-  {
-    "inputs": [
-      {
-        "internalType": "address",
-        "name": "caller",
-        "type": "address"
-      }
-    ],
-    "name": "OnlyHubOwnerFunction",
-    "type": "error"
-  },
   {
     "inputs": [
       {
@@ -572,6 +561,19 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "bool",
+        "name": "_status",
+        "type": "bool"
+      }
+    ],
+    "name": "setStatus",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "shardingTableStorage",
@@ -611,6 +613,19 @@
     "stateMutability": "view",
     "type": "function"
   },
+  {
+    "inputs": [],
+    "name": "status",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [
       {

{dkg-0.1.0b2 → dkg-0.1.0b4}/dkg/data/interfaces/ContentAssetStorage.json

@@ -10,6 +10,11 @@
     "stateMutability": "nonpayable",
     "type": "constructor"
   },
+  {
+    "inputs": [],
+    "name": "NoMintedAssets",
+    "type": "error"
+  },
   {
     "anonymous": false,
     "inputs": [
@@ -60,6 +65,38 @@
     "name": "ApprovalForAll",
     "type": "event"
   },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "_fromTokenId",
+        "type": "uint256"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "_toTokenId",
+        "type": "uint256"
+      }
+    ],
+    "name": "BatchMetadataUpdate",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "_tokenId",
+        "type": "uint256"
+      }
+    ],
+    "name": "MetadataUpdate",
+    "type": "event"
+  },
   {
     "anonymous": false,
     "inputs": [
@@ -438,6 +475,19 @@
     "stateMutability": "view",
     "type": "function"
   },
+  {
+    "inputs": [],
+    "name": "lastTokenId",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [
       {
@@ -598,6 +648,19 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "string",
+        "name": "baseURI",
+        "type": "string"
+      }
+    ],
+    "name": "setBaseURI",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
   {
     "inputs": [
       {
@@ -648,6 +711,19 @@
     "stateMutability": "view",
     "type": "function"
   },
+  {
+    "inputs": [],
+    "name": "tokenBaseURI",
+    "outputs": [
+      {
+        "internalType": "string",
+        "name": "",
+        "type": "string"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [
       {

{dkg-0.1.0b2 → dkg-0.1.0b4}/dkg/data/interfaces/HashingProxy.json

@@ -211,6 +211,32 @@
     "stateMutability": "nonpayable",
     "type": "function"
   },
+  {
+    "inputs": [
+      {
+        "internalType": "bool",
+        "name": "_status",
+        "type": "bool"
+      }
+    ],
+    "name": "setStatus",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "status",
+    "outputs": [
+      {
+        "internalType": "bool",
+        "name": "",
+        "type": "bool"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
   {
     "inputs": [],
     "name": "version",