Merge branch 'hiero-ledger:main' into main

Author: exploreriii

MAINTAINERS.md

@@ -0,0 +1,104 @@
+# Maintainers
+
+The general handling of Maintainer rights and all groups in this GitHub org is done in the https://github.com/hiero-ledger/governance repository.
+
+## Maintainer Scopes, GitHub Roles and GitHub Teams
+
+Maintainers are assigned the following scopes in this repository:
+
+| Scope      | Definition               | GitHub Role | GitHub Team                        |
+| ---------- | ------------------------ | ----------- | ---------------------------------- |
+| Maintainer | The GitHub Maintain role | Maintain    | `hiero-sdk-python-maintainers` |
+
+## Active Maintainers
+
+<!-- Please keep this sorted alphabetically by github -->
+
+| Name | GitHub ID | Scope | LFID | Discord ID | Email | Company Affiliation |
+|----- | --------- | ----- | ---- | ---------- | ----- | ------------------- |
+|      |           |       |      |            |       |                     |
+
+
+## Emeritus Maintainers
+
+| Name | GitHub ID | Scope | LFID | Discord ID | Email | Company Affiliation |
+|----- | --------- | ----- | ---- | ---------- | ----- | ------------------- |
+|      |           |       |      |            |       |                     |
+
+## The Duties of a Maintainer
+
+Maintainers are expected to perform the following duties for this repository. The duties are listed in more or less priority order:
+
+- Review, respond, and act on any security vulnerabilities reported against the repository.
+- Review, provide feedback on, and merge or reject GitHub Pull Requests from
+  Contributors.
+- Review, triage, comment on, and close GitHub Issues
+  submitted by Contributors.
+- When appropriate, lead/facilitate architectural discussions in the community.
+- When appropriate, lead/facilitate the creation of a product roadmap.
+- Create, clarify, and label issues to be worked on by Contributors.
+- Ensure that there is a well defined (and ideally automated) product test and
+  release pipeline, including the publication of release artifacts.
+- When appropriate, execute the product release process.
+- Maintain the repository CONTRIBUTING.md file and getting started documents to
+  give guidance and encouragement to those wanting to contribute to the product, and those wanting to become maintainers.
+- Contribute to the product via GitHub Pull Requests.
+- Monitor requests from the LF Decentralized Trust Technical Advisory Council about the
+contents and management of LFDT repositories, such as branch handling,
+required files in repositories and so on.
+- Contribute to the LFDT Project's Quarterly Report.
+
+## Becoming a Maintainer
+
+This community welcomes contributions. Interested contributors are encouraged to
+progress to become maintainers. To become a maintainer the following steps
+occur, roughly in order.
+
+- The proposed maintainer establishes their reputation in the community,
+  including authoring five (5) significant merged pull requests, and expresses
+  an interest in becoming a maintainer for the repository.
+- A PR is created to update this file to add the proposed maintainer to the list of active maintainers.
+- The PR is authored by an existing maintainer or has a comment on the PR from an existing maintainer supporting the proposal.
+- The PR is authored by the proposed maintainer or has a comment on the PR from the proposed maintainer confirming their interest in being a maintainer.
+  - The PR or comment from the proposed maintainer must include their
+    willingness to be a long-term (more than 6 month) maintainer.
+- Once the PR and necessary comments have been received, an approval timeframe begins.
+- The PR **MUST** be communicated on all appropriate communication channels, including relevant community calls, chat channels and mailing lists. Comments of support from the community are welcome.
+- The PR is merged and the proposed maintainer becomes a maintainer if either:
+  - Two weeks have passed since at least three (3) Maintainer PR approvals have been recorded, OR
+  - An absolute majority of maintainers have approved the PR.
+- If the PR does not get the requisite PR approvals, it may be closed.
+- Once the add maintainer PR has been merged, any necessary updates to the GitHub Teams are made.
+
+## Removing Maintainers
+
+Being a maintainer is not a status symbol or a title to be carried
+indefinitely. It will occasionally be necessary and appropriate to move a
+maintainer to emeritus status. This can occur in the following situations:
+
+- Resignation of a maintainer.
+- Violation of the Code of Conduct warranting removal.
+- Inactivity.
+  - A general measure of inactivity will be no commits or code review comments
+    for one reporting quarter. This will not be strictly enforced if
+    the maintainer expresses a reasonable intent to continue contributing.
+  - Reasonable exceptions to inactivity will be granted for known long term
+    leave such as parental leave and medical leave.
+- Other circumstances at the discretion of the other Maintainers.
+
+The process to move a maintainer from active to emeritus status is comparable to the process for adding a maintainer, outlined above. In the case of voluntary
+resignation, the Pull Request can be merged following a maintainer PR approval. If the removal is for any other reason, the following steps **SHOULD** be followed:
+
+- A PR is created to update this file to move the maintainer to the list of emeritus maintainers.
+- The PR is authored by, or has a comment supporting the proposal from, an existing maintainer or a member of the project's Technical Steering Commitee (TSC).
+- Once the PR and necessary comments have been received, the approval timeframe begins.
+- The PR **MAY** be communicated on appropriate communication channels, including relevant community calls, chat channels and mailing lists.
+- The PR is merged and the maintainer transitions to maintainer emeritus if:
+  - The PR is approved by the maintainer to be transitioned, OR
+  - Two weeks have passed since at least three (3) Maintainer PR approvals have been recorded, OR
+  - An absolute majority of maintainers have approved the PR.
+- If the PR does not get the requisite PR approvals, it may be closed.
+
+Returning to active status from emeritus status uses the same steps as adding a
+new maintainer. Note that the emeritus maintainer already has the 5 required
+significant changes as there is no contribution time horizon for those.

examples/README.md

@@ -82,40 +82,48 @@ balance = ( CryptoGetAccountBalanceQuery() .set_account_id(some_account_id) .exe
 #### Pythonic Syntax:
 ```
 transaction = TokenCreateTransaction(
-    token_name="ExampleToken",
-    token_symbol="EXT",
-    decimals=2,
-    initial_supply=1000,
-    treasury_account_id=operator_id,
-    admin_key=admin_key
-    supply_key=supply_key
+    token_params=TokenParams(
+        token_name="ExampleToken",
+        token_symbol="EXT",
+        decimals=2, # 0 for NON_FUNGIBLE_UNIQUE
+        initial_supply=1000,  # 0 for NON_FUNGIBLE_UNIQUE
+        token_type=TokenType.FUNGIBLE_COMMON,  # or TokenType.NON_FUNGIBLE_UNIQUE
+        freeze_default=False,
+        treasury_account_id=operator_id
+    ),
+    keys=TokenKeys(
+        admin_key=admin_key,       # added but optional. Necessary for Token Delete or Update.
+        supply_key=supply_key,     # added but optional. Necessary for Token Mint or Burn.
+        freeze_key=freeze_key      # added but optional. Necessary to freeze and unfreeze a token.
+    )
 ).freeze_with(client)
-
-transaction.sign(admin_key)
-transaction.sign(operator_key)
+transaction.sign(operator_key) # Required signing by the treasury account
+transaction.sign(admin_key) # Required since admin key exists
 transaction.execute(client)
-
 ```
+
 #### Method Chaining:
 ```
 transaction = (
-        TokenCreateTransaction()
-        .set_token_name("ExampleToken")
-        .set_token_symbol("EXT")
-        .set_decimals(2)
-        .set_initial_supply(1000)
-        .set_treasury_account_id(operator_id)
-        .set_admin_key(admin_key) # Optional to create a token. Necessary for Token Delete or Update.
-        .set_supply_key(supply_key) # Optional to change token supply. Necessary for Token Mint or Burn.
-        .freeze_with(client)
-    )
+    TokenCreateTransaction()  # no params => uses default placeholders which are next overwritten.
+    .set_token_name("ExampleToken")
+    .set_token_symbol("EXT")
+    .set_decimals(2) # 0 for NON_FUNGIBLE_UNIQUE
+    .set_initial_supply(1000) # 0 for NON_FUNGIBLE_UNIQUE
+    .set_token_type(TokenType.FUNGIBLE_COMMON) # or TokenType.NON_FUNGIBLE_UNIQUE
+    .set_freeze_default(False)
+    .set_treasury_account_id(operator_id)
+    .set_admin_key(admin_key)       # added but optional. Necessary for Token Delete or Update.
+    .set_supply_key(supply_key)     # added but optional. Necessary for Token Mint or Burn.
+    .set_freeze_key(freeze_key)     # added but optional. Necessary to freeze and unfreeze a token.
+    .freeze_with(client)
+)
 
-    transaction.sign(admin_key) # If admin key exists.
-    transaction.sign(operator_key)
-    transaction.execute(client)
+transaction.sign(operator_key) # Required signing by the treasury account
+transaction.sign(admin_key)    # Required since admin key exists
+transaction.execute(client)
 ```
 
-
 ### Minting a Fungible Token
 
 #### Pythonic Syntax:

examples/query_topic_message.py

@@ -20,7 +20,6 @@ def on_error_handler(e):
     query = TopicMessageQuery(
         topic_id=os.getenv('TOPIC_ID'),
         start_time=datetime.now(timezone.utc),
-
         limit=0,
         chunking_enabled=True
     )

examples/token_create.py

@@ -1,53 +1,85 @@
+"""
+This is a simple example of how to create a token using setting methods.
+
+It:
+1. Loads environment variables.
+2. Sets up a client and creates a token with the given parameters.
+3. Executes the token creation and prints the result.
+
+Required environment variables:
+- OPERATOR_ID, OPERATOR_KEY (mandatory)
+- ADMIN_KEY, SUPPLY_KEY, FREEZE_KEY (optional)
+
+Dependencies:
+- dotenv
+- hiero_sdk_python
+"""
+
+# Adapt imports and paths as appropriate
 import os
 import sys
 from dotenv import load_dotenv
-
 from hiero_sdk_python import (
     Client,
     AccountId,
     PrivateKey,
     TokenCreateTransaction,
     Network,
-)
+    TokenType
+    )
 
+# Load environment variables from .env file
 load_dotenv()
 
 def create_token():
+    """Function to create a fungible token on the Hedera network."""
+
+    # Network Setup
     network = Network(network='testnet')
     client = Client(network)
 
+    # Operator credentials (must be present)
     operator_id = AccountId.from_string(os.getenv('OPERATOR_ID'))
     operator_key = PrivateKey.from_string(os.getenv('OPERATOR_KEY'))
-    admin_key = PrivateKey.from_string(os.getenv('ADMIN_KEY'))
-    supply_key = PrivateKey.from_string(os.getenv('ADMIN_KEY')) #Optional
 
-    freeze_key = PrivateKey.from_string(os.getenv('FREEZE_KEY')) #Optional
+    # Optional Token Keys
+    admin_key = PrivateKey.from_string(os.getenv('ADMIN_KEY'))# Optional
+    supply_key = PrivateKey.from_string(os.getenv('SUPPLY_KEY')) # Optional
+    freeze_key = PrivateKey.from_string(os.getenv('FREEZE_KEY')) # Optional
 
+    # Set the operator for the client
     client.set_operator(operator_id, operator_key)
 
+    # Create the token creation transaction
+    # In this example, we set up a default empty token create transaction, then set the values
     transaction = (
         TokenCreateTransaction()
         .set_token_name("MyToken")
         .set_token_symbol("MTK")
-        .set_decimals(2)
-        .set_initial_supply(10)
-        .set_treasury_account_id(operator_id)
-        .set_admin_key(admin_key)
-        .set_supply_key(supply_key)
-        .set_freeze_key(freeze_key)
-        .freeze_with(client)
-        .sign(operator_key)
-        .sign(admin_key)
+        .set_decimals(2) # 0 for NON_FUNGIBLE_UNIQUE
+        .set_initial_supply(10) # 0 for NON_FUNGIBLE_UNIQUE
+        .set_treasury_account_id(operator_id) # Also known as treasury account
+        .set_token_type(TokenType.FUNGIBLE_COMMON) # or TokenType.NON_FUNGIBLE_UNIQUE
+        .set_admin_key(admin_key) # Optional
+        .set_supply_key(supply_key) # Optional
+        .set_freeze_key(freeze_key) # Optional
+        .freeze_with(client) # Freeze the transaction. Returns self so we can sign.
+        .sign(operator_key) # Required signature of treasury account
+        .sign(admin_key) if admin_key else None  # Only sign if admin_key is present. No need to sign with the supply or freeze keys to create the token.
 
     )
 
     try:
+
+        # Execute the transaction and get the receipt
         receipt = transaction.execute(client)
+
         if receipt and receipt.tokenId:
             print(f"Token created with ID: {receipt.tokenId}")
         else:
             print("Token creation failed: Token ID not returned in receipt.")
             sys.exit(1)
+
     except Exception as e:
         print(f"Token creation failed: {str(e)}")
         sys.exit(1)

src/hiero_sdk_python/crypto/public_key.py

@@ -142,7 +142,7 @@ def to_proto(self):
         if self.is_ed25519():
             return basic_types_pb2.Key(ed25519=pub_bytes)
         else:
-            return basic_types_pb2.Key(ECDSASecp256k1=pub_bytes)
+            return basic_types_pb2.Key(ECDSA_secp256k1=pub_bytes)
 
     def is_ed25519(self) -> bool:
         """