oli-python 1.0.0__tar.gz → 1.0.2__tar.gz

{oli_python-1.0.0 → oli_python-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oli-python
-Version: 1.0.0
+Version: 1.0.2
 Summary: Python SDK for interacting with the Open Labels Initiative; A framework for address labels in the blockchain space. Read & write labels into the OLI Label Pool, check your labels for OLI compliance.
 Home-page: https://github.com/openlabelsinitiative/oli-python
 Author: Lorenz Lehmann
@@ -45,7 +45,7 @@ import os
 # Make sure to pull in your private key from an .env file
 oli = OLI(private_key=os.environ['OLI_PRIVATE_KEY'], is_production=True)
 
-# Create an offchain label
+# Create a label
 address = "0x9438b8B447179740cD97869997a2FCc9b4AA63a2"
 chain_id = "eip155:1" # Ethereum Mainnet
 tags = {
@@ -60,12 +60,11 @@ print(f"You can attest your label: {possible_to_attest}")
 
 # Submit a label as an offchain attestation
 response = oli.submit_offchain_label(address, chain_id, tags)
-print(f"Attestation created: {response.text}")
+print(f"Label submitted offchain with response: {response.text}")
 
 # Submit a label as an onchain attestation
 tx_hash, uid = oli.submit_onchain_label(address, chain_id, tags)
-print(f"Transaction hash: {tx_hash}")
-print(f"Attestation UID: {uid}")
+print(f"Label submitted onchain with hash: {tx_hash} and uid: {uid}")
 
 # Batch submit multiple labels as one onchain attestation
 labels = [
@@ -73,14 +72,15 @@ labels = [
     {'address': address, 'chain_id': chain_id, 'tags': tags}
 ]
 tx_hash, uids = oli.submit_multi_onchain_labels(labels)
-print(f"Batch transaction hash: {tx_hash}")
-print(f"Attestation UIDs: {uids}")
+print(f"Labels batch submitted onchain with transaction hash: {tx_hash} and uids: {uids}")
 
 # Revoke an attestation (revoking onchain attestations here)
 trx_hash = oli.revoke_attestation(uid, onchain=True)
+print(f"Label {uid} revoked with hash: {trx_hash}")
 
 # Revoke multiple attestations (revoking onchain attestations here)
 trx_hash, count = oli.multi_revoke_attestations(uids, onchain=True)
+print(f"Labels batch revoked with hash: {trx_hash}")
 
 ```
 
@@ -90,8 +90,8 @@ trx_hash, count = oli.multi_revoke_attestations(uids, onchain=True)
 from oli import OLI
 import os
 
-# Initialize the client (read only mode doesn't require a private key)
-oli = OLI(is_production=True)
+# Initialize the client (read mode only doesn't require a private key)
+oli = OLI()
 
 # Query attestations for a specific address
 result = oli.graphql_query_attestations(address=address)

{oli_python-1.0.0 → oli_python-1.0.2}/README.md

@@ -18,7 +18,7 @@ import os
 # Make sure to pull in your private key from an .env file
 oli = OLI(private_key=os.environ['OLI_PRIVATE_KEY'], is_production=True)
 
-# Create an offchain label
+# Create a label
 address = "0x9438b8B447179740cD97869997a2FCc9b4AA63a2"
 chain_id = "eip155:1" # Ethereum Mainnet
 tags = {
@@ -33,12 +33,11 @@ print(f"You can attest your label: {possible_to_attest}")
 
 # Submit a label as an offchain attestation
 response = oli.submit_offchain_label(address, chain_id, tags)
-print(f"Attestation created: {response.text}")
+print(f"Label submitted offchain with response: {response.text}")
 
 # Submit a label as an onchain attestation
 tx_hash, uid = oli.submit_onchain_label(address, chain_id, tags)
-print(f"Transaction hash: {tx_hash}")
-print(f"Attestation UID: {uid}")
+print(f"Label submitted onchain with hash: {tx_hash} and uid: {uid}")
 
 # Batch submit multiple labels as one onchain attestation
 labels = [
@@ -46,14 +45,15 @@ labels = [
     {'address': address, 'chain_id': chain_id, 'tags': tags}
 ]
 tx_hash, uids = oli.submit_multi_onchain_labels(labels)
-print(f"Batch transaction hash: {tx_hash}")
-print(f"Attestation UIDs: {uids}")
+print(f"Labels batch submitted onchain with transaction hash: {tx_hash} and uids: {uids}")
 
 # Revoke an attestation (revoking onchain attestations here)
 trx_hash = oli.revoke_attestation(uid, onchain=True)
+print(f"Label {uid} revoked with hash: {trx_hash}")
 
 # Revoke multiple attestations (revoking onchain attestations here)
 trx_hash, count = oli.multi_revoke_attestations(uids, onchain=True)
+print(f"Labels batch revoked with hash: {trx_hash}")
 
 ```
 
@@ -63,8 +63,8 @@ trx_hash, count = oli.multi_revoke_attestations(uids, onchain=True)
 from oli import OLI
 import os
 
-# Initialize the client (read only mode doesn't require a private key)
-oli = OLI(is_production=True)
+# Initialize the client (read mode only doesn't require a private key)
+oli = OLI()
 
 # Query attestations for a specific address
 result = oli.graphql_query_attestations(address=address)

{oli_python-1.0.0 → oli_python-1.0.2}/oli/attestation/offchain.py

@@ -32,7 +32,7 @@ class OffchainAttestations:
         tags = self.oli.validator.fix_simple_tags_formatting(tags)
 
         # Check all necessary input parameters
-        self.oli.validator.check_label_correctness(address, chain_id, tags, ref_uid, auto_fix=False)
+        self.oli.validator.validate_label_correctness(address, chain_id, tags, ref_uid, auto_fix=False)
         
         # Encode the label data
         data = self.oli.utils_other.encode_label_data(chain_id, tags)

{oli_python-1.0.0 → oli_python-1.0.2}/oli/attestation/onchain.py

@@ -27,7 +27,7 @@ class OnchainAttestations:
         tags = self.oli.validator.fix_simple_tags_formatting(tags)
 
         # Check all necessary input parameters
-        self.oli.validator.check_label_correctness(address, chain_id, tags, ref_uid, auto_fix=False)
+        self.oli.validator.validate_label_correctness(address, chain_id, tags, ref_uid, auto_fix=False)
 
         # Encode the label data
         data = self.oli.utils_other.encode_label_data(chain_id, tags)
@@ -107,13 +107,13 @@ class OnchainAttestations:
             label['tags'] = self.oli.validator.fix_simple_tags_formatting(label['tags'])
 
             # run checks on each label
-            self.oli.validator.check_label_correctness(label['address'], label['chain_id'], label['tags'], auto_fix=False)
+            self.oli.validator.validate_label_correctness(label['address'], label['chain_id'], label['tags'], auto_fix=False)
 
             # check if ref_uid is provided
             if 'ref_uid' not in label:
                 label['ref_uid'] = "0x0000000000000000000000000000000000000000000000000000000000000000"
             else:
-                self.oli.validator.checks_ref_uid(label['ref_uid'])
+                self.oli.validator.validate_ref_uid(label['ref_uid'])
 
             # ABI encode data for each attestation
             data = self.oli.utils_other.encode_label_data(label['chain_id'], label['tags'])

{oli_python-1.0.0 → oli_python-1.0.2}/oli/attestation/utils_validator.py

@@ -69,7 +69,7 @@ class UtilsValidator:
         self.validate_address(address)
         self.validate_chain_id(chain_id)
         self.validate_tags(tags, auto_fix=auto_fix)
-        self.checks_ref_uid(ref_uid)
+        self.validate_ref_uid(ref_uid)
         return True
         
     def validate_chain_id(self, chain_id: str) -> bool:

{oli_python-1.0.0 → oli_python-1.0.2}/oli/core.py

@@ -12,7 +12,7 @@ from oli.data.fetcher import DataFetcher
 from oli.data.graphql import GraphQLClient
 
 class OLI:
-    def __init__(self, private_key: str, is_production: bool=True, custom_rpc_url: str=None) -> None:
+    def __init__(self, private_key: str=None, is_production: bool=True, custom_rpc_url: str=None) -> None:
         """
         Initialize the OLI API client.
         
@@ -51,18 +51,19 @@ class OLI:
             private_key = os.environ.get('OLI_PRIVATE_KEY')
             if not private_key:
                 print("WARNING: Private key not provided. Please set the OLI_PRIVATE_KEY environment variable in case you plan to submit labels.")
-
-        # Convert the hex private key to the proper key object
-        self.private_key = private_key
-        if private_key.startswith('0x'):
-            private_key_bytes = private_key[2:]
-        else:
-            private_key_bytes = private_key
-        private_key_obj = keys.PrivateKey(bytes.fromhex(private_key_bytes))
+                print("WARNING: OLI client in read mode only.")
         
-        # Create account from private key
-        self.account = eth_account.Account.from_key(private_key_obj)
-        self.address = self.account.address
+        self.private_key = private_key
+        if self.private_key:
+            # Convert the hex private key to the proper key object
+            if private_key.startswith('0x'):
+                private_key_bytes = private_key[2:]
+            else:
+                private_key_bytes = private_key
+            # Create account from private key
+            private_key_obj = keys.PrivateKey(bytes.fromhex(private_key_bytes))
+            self.account = eth_account.Account.from_key(private_key_obj)
+            self.address = self.account.address
         
         # Label Pool Schema for OLI
         self.oli_label_pool_schema = '0xb763e62d940bed6f527dd82418e146a904e62a297b8fa765c9b3e1f0bc6fdd68'

{oli_python-1.0.0 → oli_python-1.0.2}/oli_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oli-python
-Version: 1.0.0
+Version: 1.0.2
 Summary: Python SDK for interacting with the Open Labels Initiative; A framework for address labels in the blockchain space. Read & write labels into the OLI Label Pool, check your labels for OLI compliance.
 Home-page: https://github.com/openlabelsinitiative/oli-python
 Author: Lorenz Lehmann
@@ -45,7 +45,7 @@ import os
 # Make sure to pull in your private key from an .env file
 oli = OLI(private_key=os.environ['OLI_PRIVATE_KEY'], is_production=True)
 
-# Create an offchain label
+# Create a label
 address = "0x9438b8B447179740cD97869997a2FCc9b4AA63a2"
 chain_id = "eip155:1" # Ethereum Mainnet
 tags = {
@@ -60,12 +60,11 @@ print(f"You can attest your label: {possible_to_attest}")
 
 # Submit a label as an offchain attestation
 response = oli.submit_offchain_label(address, chain_id, tags)
-print(f"Attestation created: {response.text}")
+print(f"Label submitted offchain with response: {response.text}")
 
 # Submit a label as an onchain attestation
 tx_hash, uid = oli.submit_onchain_label(address, chain_id, tags)
-print(f"Transaction hash: {tx_hash}")
-print(f"Attestation UID: {uid}")
+print(f"Label submitted onchain with hash: {tx_hash} and uid: {uid}")
 
 # Batch submit multiple labels as one onchain attestation
 labels = [
@@ -73,14 +72,15 @@ labels = [
     {'address': address, 'chain_id': chain_id, 'tags': tags}
 ]
 tx_hash, uids = oli.submit_multi_onchain_labels(labels)
-print(f"Batch transaction hash: {tx_hash}")
-print(f"Attestation UIDs: {uids}")
+print(f"Labels batch submitted onchain with transaction hash: {tx_hash} and uids: {uids}")
 
 # Revoke an attestation (revoking onchain attestations here)
 trx_hash = oli.revoke_attestation(uid, onchain=True)
+print(f"Label {uid} revoked with hash: {trx_hash}")
 
 # Revoke multiple attestations (revoking onchain attestations here)
 trx_hash, count = oli.multi_revoke_attestations(uids, onchain=True)
+print(f"Labels batch revoked with hash: {trx_hash}")
 
 ```
 
@@ -90,8 +90,8 @@ trx_hash, count = oli.multi_revoke_attestations(uids, onchain=True)
 from oli import OLI
 import os
 
-# Initialize the client (read only mode doesn't require a private key)
-oli = OLI(is_production=True)
+# Initialize the client (read mode only doesn't require a private key)
+oli = OLI()
 
 # Query attestations for a specific address
 result = oli.graphql_query_attestations(address=address)

{oli_python-1.0.0 → oli_python-1.0.2}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="oli-python",
-    version="1.0.0",
+    version="1.0.2",
     author="Lorenz Lehmann",
     author_email="lorenz@growthepie.xyz",
     description="Python SDK for interacting with the Open Labels Initiative; A framework for address labels in the blockchain space. Read & write labels into the OLI Label Pool, check your labels for OLI compliance.",