hiero-sdk-python 0.1.2__tar.gz → 0.1.4__tar.gz

{hiero_sdk_python-0.1.2 → hiero_sdk_python-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hiero-sdk-python
-Version: 0.1.2
+Version: 0.1.4
 Summary: A Hiero SDK in pure Python
 Author-Email: Nadine Loepfe <nadine.loepfe@hashgraph.com>, Richard Bair <rbair23@users.noreply.github.com>
 Maintainer-Email: Nadine Loepfe <nadine.loepfe@hashgraph.com>
@@ -219,13 +219,19 @@ Requires-Dist: grpcio==1.68.1
 Requires-Dist: cryptography==44.0.0
 Requires-Dist: python-dotenv==1.0.1
 Requires-Dist: requests==2.32.3
+Requires-Dist: pycryptodome==3.23.0
+Requires-Dist: eth-abi==5.2.0
 Description-Content-Type: text/markdown
 
 # Hiero SDK in Python
 
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/hiero-ledger/hiero-sdk-python/badge)](https://scorecard.dev/viewer/?uri=github.com/hiero-ledger/hiero-sdk-python)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/10697/badge)](https://bestpractices.coreinfrastructure.org/projects/10697)
+[![License](https://img.shields.io/badge/license-apache2-blue.svg)](LICENSE)
+
 This is a Python SDK for interacting with the Hedera Hashgraph platform. It allows developers to:
 
-- Manage Token Transactions like Create, Mint Fungible, Mint Non-Fungible, Associate, Dissociate, Transfer, Freeze & Delete
+- Manage Token Transactions like Create, Mint Fungible, Mint Non-Fungible, Associate, Dissociate, Transfer, Freeze, Unfreeze & Delete
 - Manage Consensus Transactions like Topic Create, Update, Delete
 - Submit Topic Messages
 - Query Account Balance, Transaction Receipts, Topic Infos and Messages
@@ -248,7 +254,7 @@ The latest release of this SDK is published to PyPI. You can install it with:
 
 ```
 pip install --upgrade pip
-pip install hiero_sdk_python
+pip install hiero-sdk-python
 ```
 
 This will pull down a stable release along with the required dependencies.
@@ -278,7 +284,7 @@ Other installation methods can be found [here](https://docs.astral.sh/uv/getting
 2. Clone this repository:
 
 ```bash
-git clone https://github.com/hiero-ledger/hiero_sdk_python.git
+git clone https://github.com/hiero-ledger/hiero-sdk-python.git
 cd hiero-sdk-python
 ```
 
@@ -318,17 +324,21 @@ Create a .env file in the root of your project with the following (replace with
 
 ```
 OPERATOR_ID=0.0.1234xx
-OPERATOR_KEY=302e020100300506032b657004220420...
-ADMIN_KEY=302a300506032b65700321009308ecfdf...
+OPERATOR_KEY=af20e47d590300506032b657004220420...
+NETWORK=testnet
+
+# optional:
+ADMIN_KEY=af20e47d59032b65700321009308ecfdf...
 SUPPLY_KEY =302a300506032b6570032100c5e4af5..."
 FREEZE_KEY=302a300306072b65700321009308ecfdf...
 RECIPIENT_ID=0.0.789xx
 TOKEN_ID=0.0.100xx
 TOPIC_ID=0.0.200xx
 FREEZE_ACCOUNT_ID=0.0.100
-NETWORK=testnet
 ```
 
+The only environment variables needed are OPERATOR_ID, OPERATOR_KEY and NETWORK. The rest is optional (if customisation of the example scripts is needed).
+
 A [sample .env](.env.example) file is provided in the root of this project. If you do not have an account on
 the Hedera testnet, you can easily get one from the [Hedera Portal](https://portal.hedera.com/). Learn more about
 testnet [here](https://docs.hedera.com/guides/testnet).
@@ -341,9 +351,9 @@ uv run pytest
 ```
 
 The test file in the root of this project will be automatically run when pushing onto a branch.
-This is done by running 'Hedera Solo'. Read more about it here:
+This is done by running 'Hiero Solo Action'. Read more about it here:
 
-- [Github Marketplace](https://github.com/marketplace/actions/hedera-solo)
+- [Github Marketplace](https://github.com/marketplace/actions/hiero-solo-action)
 - [Blog Post by Hendrik Ebbers](https://dev.to/hendrikebbers/ci-for-hedera-based-projects-2nja)
 
 #### Output:
@@ -357,6 +367,7 @@ Token dissociation successful.
 Token minting successful.
 Token transfer successful.
 Token freeze successful.
+Token Unfreeze successful.
 Token deletion successful.
 Topic creation successful.
 Topic Message submitted.
@@ -370,4 +381,4 @@ We appreciate your interest in improving the Hiero Python SDK! Please see CONTRI
 
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the MIT License.

{hiero_sdk_python-0.1.2 → hiero_sdk_python-0.1.4}/README.md

@@ -1,8 +1,12 @@
 # Hiero SDK in Python
 
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/hiero-ledger/hiero-sdk-python/badge)](https://scorecard.dev/viewer/?uri=github.com/hiero-ledger/hiero-sdk-python)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/10697/badge)](https://bestpractices.coreinfrastructure.org/projects/10697)
+[![License](https://img.shields.io/badge/license-apache2-blue.svg)](LICENSE)
+
 This is a Python SDK for interacting with the Hedera Hashgraph platform. It allows developers to:
 
-- Manage Token Transactions like Create, Mint Fungible, Mint Non-Fungible, Associate, Dissociate, Transfer, Freeze & Delete
+- Manage Token Transactions like Create, Mint Fungible, Mint Non-Fungible, Associate, Dissociate, Transfer, Freeze, Unfreeze & Delete
 - Manage Consensus Transactions like Topic Create, Update, Delete
 - Submit Topic Messages
 - Query Account Balance, Transaction Receipts, Topic Infos and Messages
@@ -25,7 +29,7 @@ The latest release of this SDK is published to PyPI. You can install it with:
 
 ```
 pip install --upgrade pip
-pip install hiero_sdk_python
+pip install hiero-sdk-python
 ```
 
 This will pull down a stable release along with the required dependencies.
@@ -55,7 +59,7 @@ Other installation methods can be found [here](https://docs.astral.sh/uv/getting
 2. Clone this repository:
 
 ```bash
-git clone https://github.com/hiero-ledger/hiero_sdk_python.git
+git clone https://github.com/hiero-ledger/hiero-sdk-python.git
 cd hiero-sdk-python
 ```
 
@@ -95,17 +99,21 @@ Create a .env file in the root of your project with the following (replace with
 
 ```
 OPERATOR_ID=0.0.1234xx
-OPERATOR_KEY=302e020100300506032b657004220420...
-ADMIN_KEY=302a300506032b65700321009308ecfdf...
+OPERATOR_KEY=af20e47d590300506032b657004220420...
+NETWORK=testnet
+
+# optional:
+ADMIN_KEY=af20e47d59032b65700321009308ecfdf...
 SUPPLY_KEY =302a300506032b6570032100c5e4af5..."
 FREEZE_KEY=302a300306072b65700321009308ecfdf...
 RECIPIENT_ID=0.0.789xx
 TOKEN_ID=0.0.100xx
 TOPIC_ID=0.0.200xx
 FREEZE_ACCOUNT_ID=0.0.100
-NETWORK=testnet
 ```
 
+The only environment variables needed are OPERATOR_ID, OPERATOR_KEY and NETWORK. The rest is optional (if customisation of the example scripts is needed).
+
 A [sample .env](.env.example) file is provided in the root of this project. If you do not have an account on
 the Hedera testnet, you can easily get one from the [Hedera Portal](https://portal.hedera.com/). Learn more about
 testnet [here](https://docs.hedera.com/guides/testnet).
@@ -118,9 +126,9 @@ uv run pytest
 ```
 
 The test file in the root of this project will be automatically run when pushing onto a branch.
-This is done by running 'Hedera Solo'. Read more about it here:
+This is done by running 'Hiero Solo Action'. Read more about it here:
 
-- [Github Marketplace](https://github.com/marketplace/actions/hedera-solo)
+- [Github Marketplace](https://github.com/marketplace/actions/hiero-solo-action)
 - [Blog Post by Hendrik Ebbers](https://dev.to/hendrikebbers/ci-for-hedera-based-projects-2nja)
 
 #### Output:
@@ -134,6 +142,7 @@ Token dissociation successful.
 Token minting successful.
 Token transfer successful.
 Token freeze successful.
+Token Unfreeze successful.
 Token deletion successful.
 Topic creation successful.
 Topic Message submitted.
@@ -147,4 +156,4 @@ We appreciate your interest in improving the Hiero Python SDK! Please see CONTRI
 
 ## License
 
-This project is licensed under the MIT License.
+This project is licensed under the MIT License.

{hiero_sdk_python-0.1.2 → hiero_sdk_python-0.1.4}/pyproject.toml

@@ -18,6 +18,8 @@ dependencies = [
     "cryptography==44.0.0",
     "python-dotenv==1.0.1",
     "requests==2.32.3",
+    "pycryptodome==3.23.0",
+    "eth-abi==5.2.0",
 ]
 classifiers = [
     "Development Status :: 2 - Pre-Alpha",
@@ -27,7 +29,7 @@ classifiers = [
     "Intended Audience :: Developers",
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
-version = "0.1.2"
+version = "0.1.4"
 
 [project.license]
 file = "LICENSE"
@@ -64,6 +66,10 @@ excludes = [
 [tool.pytest.ini_options]
 pythonpath = [
     "src",
+    ".",
+]
+testpaths = [
+    "tests",
 ]
 
 [tool.ruff]

hiero_sdk_python-0.1.4/src/hiero_sdk_python/Duration.py

@@ -0,0 +1,32 @@
+from dataclasses import dataclass
+from hiero_sdk_python.hapi.services.duration_pb2 import Duration as proto_Duration
+
+@dataclass(frozen=True, init=True)
+class Duration:
+    """A frozen dataclass representing a duration in seconds."""
+    seconds: int
+
+    def __post_init__(self) -> None:
+        """Validate types after initialization."""
+        if not isinstance(self.seconds, int):
+            raise TypeError(f"seconds must be an integer, got {type(self.seconds).__name__}")
+
+    def _to_proto(self) -> proto_Duration:
+        return proto_Duration(seconds=self.seconds)
+
+    @classmethod
+    def _from_proto(cls, proto: proto_Duration) -> 'Duration':
+        if isinstance(proto, Duration):
+            raise ValueError("Invalid duration proto")
+        return cls(seconds=proto.seconds)
+
+    def __str__(self) -> str:
+        return f"Duration of {self.seconds} seconds."
+
+    def __repr__(self) -> str:
+        return f"Duration(seconds={self.seconds})"
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, Duration):
+            return False
+        return self.seconds == other.seconds

hiero_sdk_python-0.1.4/src/hiero_sdk_python/__init__.py

@@ -0,0 +1,207 @@
+# Client and Network
+from .client.client import Client
+from .client.network import Network
+
+# Account
+from .account.account_id import AccountId
+from .account.account_create_transaction import AccountCreateTransaction
+from .account.account_update_transaction import AccountUpdateTransaction
+from .account.account_info import AccountInfo
+
+# Crypto
+from .crypto.private_key import PrivateKey
+from .crypto.public_key import PublicKey
+
+# Tokens
+from .tokens.token_create_transaction import TokenCreateTransaction
+from .tokens.token_associate_transaction import TokenAssociateTransaction
+from .tokens.token_dissociate_transaction import TokenDissociateTransaction
+from .tokens.token_delete_transaction import TokenDeleteTransaction
+from .tokens.token_info import TokenInfo
+from .tokens.token_mint_transaction import TokenMintTransaction
+from .tokens.token_freeze_transaction import TokenFreezeTransaction
+from .tokens.token_unfreeze_transaction import TokenUnfreezeTransaction
+from .tokens.token_wipe_transaction import TokenWipeTransaction
+from .tokens.token_reject_transaction import TokenRejectTransaction
+from .tokens.token_update_nfts_transaction import TokenUpdateNftsTransaction
+from .tokens.token_burn_transaction import TokenBurnTransaction
+from .tokens.token_grant_kyc_transaction import TokenGrantKycTransaction
+from .tokens.token_revoke_kyc_transaction import TokenRevokeKycTransaction
+from .tokens.token_update_transaction import TokenUpdateTransaction
+from .tokens.token_airdrop_transaction import TokenAirdropTransaction
+from .tokens.token_cancel_airdrop_transaction import TokenCancelAirdropTransaction
+from .tokens.pending_airdrop_id import PendingAirdropId
+from .tokens.pending_airdrop_record import PendingAirdropRecord
+from .tokens.token_id import TokenId
+from .tokens.token_type import TokenType
+from .tokens.supply_type import SupplyType
+from .tokens.nft_id import NftId
+from .tokens.token_nft_transfer import TokenNftTransfer
+from .tokens.token_nft_info import TokenNftInfo
+from .tokens.token_relationship import TokenRelationship
+
+# Transaction
+from .transaction.transfer_transaction import TransferTransaction
+from .transaction.transaction_id import TransactionId
+from .transaction.transaction_receipt import TransactionReceipt
+from .transaction.transaction_response import TransactionResponse
+from .transaction.transaction_record import TransactionRecord
+
+# Response / Codes
+from .response_code import ResponseCode
+
+# HBAR
+from .hbar import Hbar
+
+# Timestamp
+from .timestamp import Timestamp
+
+# Duration
+from .Duration import Duration
+
+# Consensus
+from .consensus.topic_create_transaction import TopicCreateTransaction
+from .consensus.topic_message_submit_transaction import TopicMessageSubmitTransaction
+from .consensus.topic_update_transaction import TopicUpdateTransaction
+from .consensus.topic_delete_transaction import TopicDeleteTransaction
+from .consensus.topic_id import TopicId
+
+# Queries
+from .query.topic_info_query import TopicInfoQuery
+from .query.topic_message_query import TopicMessageQuery
+from .query.transaction_get_receipt_query import TransactionGetReceiptQuery
+from .query.transaction_record_query import TransactionRecordQuery
+from .query.account_balance_query import CryptoGetAccountBalanceQuery
+from .query.token_nft_info_query import TokenNftInfoQuery
+from .query.token_info_query import TokenInfoQuery
+from .query.account_info_query import AccountInfoQuery
+
+# Address book
+from .address_book.endpoint import Endpoint
+from .address_book.node_address import NodeAddress
+
+# Logger
+from .logger.logger import Logger
+from .logger.log_level import LogLevel
+
+# File
+from .file.file_create_transaction import FileCreateTransaction
+from .file.file_append_transaction import FileAppendTransaction
+from .file.file_info_query import FileInfoQuery
+from .file.file_info import FileInfo
+from .file.file_contents_query import FileContentsQuery
+from .file.file_update_transaction import FileUpdateTransaction
+from .file.file_delete_transaction import FileDeleteTransaction
+
+# Contract
+from .contract.contract_create_transaction import ContractCreateTransaction
+from .contract.contract_call_query import ContractCallQuery
+from .contract.contract_info_query import ContractInfoQuery
+from .contract.contract_bytecode_query import ContractBytecodeQuery
+from .contract.contract_function_parameters import ContractFunctionParameters
+from .contract.contract_function_result import ContractFunctionResult
+from .contract.contract_info import ContractInfo
+from .contract.contract_update_transaction import ContractUpdateTransaction
+
+__all__ = [
+    # Client
+    "Client",
+    "Network",
+
+    # Account
+    "AccountId",
+    "AccountCreateTransaction",
+    "AccountUpdateTransaction",
+    "AccountInfo",
+
+    # Crypto
+    "PrivateKey",
+    "PublicKey",
+
+    # Tokens
+    "TokenCreateTransaction",
+    "TokenAssociateTransaction",
+    "TokenDissociateTransaction",
+    "TokenDeleteTransaction",
+    "TokenMintTransaction",
+    "TokenFreezeTransaction",
+    "TokenUnfreezeTransaction",
+    "TokenWipeTransaction",
+    "TokenId",
+    "NftId",
+    "TokenInfo",
+    "TokenNftTransfer",
+    "TokenNftInfo",
+    "TokenRejectTransaction",
+    "TokenUpdateNftsTransaction",
+    "TokenBurnTransaction",
+    "TokenGrantKycTransaction",
+    "TokenRelationship",
+    "TokenUpdateTransaction",
+    "TokenAirdropTransaction",
+    "TokenCancelAirdropTransaction",
+    "PendingAirdropId",
+    "PendingAirdropRecord",
+    "TokenType",
+    "SupplyType",
+
+    # Transaction
+    "TransferTransaction",
+    "TransactionId",
+    "TransactionReceipt",
+    "TransactionResponse",
+    "TransactionRecord",
+
+    # Response
+    "ResponseCode",
+
+    # Consensus
+    "TopicCreateTransaction",
+    "TopicMessageSubmitTransaction",
+    "TopicUpdateTransaction",
+    "TopicDeleteTransaction",
+    "TopicId",
+
+    # Queries
+    "TopicInfoQuery",
+    "TopicMessageQuery",
+    "TransactionGetReceiptQuery",
+    "TransactionRecordQuery",
+    "CryptoGetAccountBalanceQuery",
+    "TokenNftInfoQuery",
+    "TokenInfoQuery",
+    "AccountInfoQuery",
+
+    # Address book
+    "Endpoint",
+    "NodeAddress",
+
+    # Logger
+    "Logger",
+    "LogLevel",
+
+    # HBAR
+    "Hbar",
+    "ResponseCode",
+    "Timestamp",
+    "Duration",
+
+    # File
+    "FileCreateTransaction",
+    "FileAppendTransaction",
+    "FileInfoQuery",
+    "FileInfo",
+    "FileContentsQuery",
+    "FileUpdateTransaction",
+    "FileDeleteTransaction",
+
+    # Contract
+    "ContractCreateTransaction",
+    "ContractCallQuery",
+    "ContractInfoQuery",
+    "ContractBytecodeQuery",
+    "ContractFunctionParameters",
+    "ContractFunctionResult",
+    "ContractInfo",
+    "ContractUpdateTransaction",
+]

hiero_sdk_python-0.1.4/src/hiero_sdk_python/_deprecated.py

@@ -0,0 +1,62 @@
+"""Provides a mixin to emit FutureWarnings for deprecated camelCase attributes."""
+import warnings
+
+
+class _DeprecatedAliasesMixin:  # pylint: disable=too-few-public-methods
+    """
+    Mixin that maps legacy camelCase names to new snake_case attributes,
+    emitting a FutureWarning at use.
+    """
+
+    _ALIASES = {
+        "tokenId": "token_id",
+        "totalSupply": "total_supply",
+        "isDeleted": "is_deleted",
+        "tokenType": "token_type",
+        "maxSupply": "max_supply",
+        "adminKey": "admin_key",
+        "kycKey": "kyc_key",
+        "freezeKey": "freeze_key",
+        "wipeKey": "wipe_key",
+        "supplyKey": "supply_key",
+        "defaultFreezeStatus": "default_freeze_status",
+        "defaultKycStatus": "default_kyc_status",
+        "autoRenewAccount": "auto_renew_account",
+        "autoRenewPeriod": "auto_renew_period",
+        "pauseKey": "pause_key",
+        "pauseStatus": "pause_status",
+        "supplyType": "supply_type",
+
+        "serialNumber": "serial_number",
+
+        "topicId": "topic_id",
+        "accountId": "account_id",
+        "fileId": "file_id"
+    }
+
+    def __getattr__(self, name):
+        try:
+            snake = self._ALIASES[name]
+        except KeyError as exc:
+            raise AttributeError(
+                f"{self.__class__.__name__!r} has no attribute {name!r}"
+            ) from exc
+
+        warnings.warn(
+            f"{self.__class__.__name__}.{name} will be deprecated; use .{snake}",
+            FutureWarning,
+            stacklevel=2,
+        )
+        return getattr(self, snake)
+
+    def __setattr__(self, name, value):
+        # intercept legacy writes
+        if name in self._ALIASES:
+            snake = self._ALIASES[name]
+            warnings.warn(
+                f"{self.__class__.__name__}.{name}= is deprecated; use .{snake}=",
+                FutureWarning,
+                stacklevel=2,
+            )
+            name = snake
+        super().__setattr__(name, value)

{hiero_sdk_python-0.1.2 → hiero_sdk_python-0.1.4}/src/hiero_sdk_python/account/account_balance.py

@@ -1,5 +1,8 @@
+from typing import Dict
+
 from hiero_sdk_python.tokens.token_id import TokenId
 from hiero_sdk_python.hbar import Hbar
+from hiero_sdk_python.hapi.services.crypto_get_account_balance_pb2 import CryptoGetAccountBalanceResponse
 
 class AccountBalance:
     """
@@ -10,7 +13,7 @@ class AccountBalance:
         token_balances (dict): A dictionary mapping TokenId to token balances.
     """
 
-    def __init__(self, hbars, token_balances=None):
+    def __init__(self, hbars: Hbar, token_balances: Dict[TokenId,int] = None) -> None:
         """
         Initializes the AccountBalance with the given hbar balance and token balances.
 
@@ -22,7 +25,8 @@ class AccountBalance:
         self.token_balances = token_balances or {}
 
     @classmethod
-    def from_proto(cls, proto):
+
+    def _from_proto(cls, proto: CryptoGetAccountBalanceResponse) -> "AccountBalance":
         """
         Creates an AccountBalance instance from a protobuf response.
 
@@ -32,13 +36,13 @@ class AccountBalance:
         Returns:
             AccountBalance: The account balance instance.
         """
-        hbars = Hbar.from_tinybars(proto.balance)
+        hbars: Hbar = Hbar.from_tinybars(tinybars=proto.balance)
 
-        token_balances = {}
+        token_balances: Dict[TokenId,int] = {}
         if proto.tokenBalances:
             for token_balance in proto.tokenBalances:
-                token_id = TokenId.from_proto(token_balance.tokenId)
-                balance = token_balance.balance
+                token_id: TokenId = TokenId._from_proto(token_balance.tokenId)
+                balance: int = token_balance.balance
                 token_balances[token_id] = balance
 
         return cls(hbars=hbars, token_balances=token_balances)