[Beginner]: Refactor def setup_client() in examples/account

[exploreriii]

🐥 Beginner Friendly

This issue is intended for contributors who have previously completed a Good First Issue in Hiero and are at a beginner level.
We recognize that gaining confidence and building skills are equally important steps in the open-source contributor journey.
The purpose of this issue—and others listed under Find a beginner issue—is to provide a supportive, low-pressure environment where you can learn, practice, and grow your contribution skills with confidence.

👾 Description of the issue

At examples/account we have several examples relating to accounts.

Some of these have a set up client function.

For example:
examples/account/account_allowance_approve_transaction_hbar.py

has:

load_dotenv()
network_name = os.getenv("NETWORK", "testnet").lower()


def setup_client() -> Client:
    """Initialize and set up the client with operator account using env vars."""
    network = Network(network_name)
    print(f"Connecting to Hedera {network_name} network!")
    client = Client(network)

    operator_id = AccountId.from_string(os.getenv("OPERATOR_ID", ""))
    operator_key = PrivateKey.from_string(os.getenv("OPERATOR_KEY", ""))
    client.set_operator(operator_id, operator_key)
    print(f"Client set up with operator id {client.operator_account_id}")

    return client

We now have a method defined at src/hiero_sdk_python/client/client.py that will enable you to do this a lot quicker

    @classmethod
    def from_env(cls, network: Optional[NetworkName] = None) -> "Client":
        """
        Initialize client from environment variables.
        Automatically loads .env file if present.

        Args:
            network (str, optional): Override the network ("testnet", "mainnet", "previewnet").
                                     If not provided, checks 'NETWORK' env var. 
                                     Defaults to 'testnet' if neither is set.

        Raises:
            ValueError: If OPERATOR_ID or OPERATOR_KEY environment variables are not set.

        Example:
            # Defaults to testnet if no env vars set
            client = Client.from_env()
        """
        load_dotenv()
        
        if network:
            network_name = network
        else:
            network_name = os.getenv('NETWORK') or 'testnet'

        network_name = network_name.lower()
        
        try:
            client = cls(Network(network_name))
        except ValueError:
            raise ValueError(f"Invalid network name: {network_name}")

        operator_id_str = os.getenv("OPERATOR_ID")
        operator_key_str = os.getenv("OPERATOR_KEY")

        if not operator_id_str:
            raise ValueError("OPERATOR_ID environment variable is required for Client.from_env()")
        if not operator_key_str:
            raise ValueError("OPERATOR_KEY environment variable is required for Client.from_env()")

        operator_id = AccountId.from_string(operator_id_str)
        operator_key = PrivateKey.from_string(operator_key_str)

        client.set_operator(operator_id, operator_key)

        return client

💡 Proposed Solution

This means we can refactor the old-style set up client function to use this new from_env method, removing many lines of code.

We can do this for all examples/account that set up a client.

👩‍💻 Implementation Steps

Refactor the old set up client with the new method
Remove unused imports/etc

See examples at:
examples/client/client.py
or:
examples/account/account_create_transaction_without_alias.py

Please complete this for all remaining account examples

✅ Acceptance Criteria

To be able to merge a pull request for this issue, we need:

• Assignment: You must be assigned to the issue, comment: /assign in the issue to get assigned see guide
• Changelog Entry: Correct changelog entry see guide
• Signed commits: commits must be DCO and GPG key signed see guide
• All Tests Pass: our workflow checks like unit and integration tests must pass
• Issue is Solved: The implementation fully addresses the issue requirements as described above
• No Further Changes are Made: Code review feedback has been addressed and no further changes are requested

📋 Step-by-Step Contribution Guide

• Assignment: You must be assigned to the issue, comment: /assign in the issue to get assigned see guide
• Fork, Branch and Work on the issue: Create a copy of the repository, create a branch for the issue and solve the problem. For instructions, please read our Contributing guide file. Further help can be found at Set-up Training and Workflow Training.
• DCO and GPG key sign each commit : each commit must be -s and -S signed. An explanation on how to do this is at Signing Guide
• Add a Changelog Entry : your pull request will require a changelog. Read Changelog Entry Guide to learn how.
• Push and Create a Pull Request : Once your issue is resolved, and your commits are signed, and you have a changelog entry, push your changes and create a pull request. Detailed instructions can be found at Submit PR Training, part of Workflow Training.
• You did it 🎉: A maintainer or committer will review your pull request and provide feedback. If approved, we will merge the fix in the main branch. Thanks for being part of the Hiero community as an open-source contributor ❤️

IMPORTANT You will ONLY be assigned to the issue if you comment: /assign
IMPORTANT Your pull request CANNOT BE MERGED until you add a changelog entry AND sign your commits each with git commit -S -s -m "chore: your commit message" with a GPG key setup.

🤔 Additional Information

For more help, we have extensive documentation:

• SDK Developer Docs
• SDK Developer Training

Additionally, we invite you to join our community on our Discord server.

We also invite you to attend each Wednesday, 2pm UTC our Python SDK Office Hour and Community Calls. The Python SDK Office hour is for hands-on-help and the Community Call for general community discussion.

You can also ask for help in a comment below!

[github-actions]

@coderabbitai plan

[coderabbitai]

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Fetch details of issue #1471 from the repository
gh issue view 1471 --repo hiero-ledger/hiero-sdk-python --json title,body,comments,labels,author

Length of output: 8856

---

🏁 Script executed:

#!/bin/bash
# Find all Python files in examples/account/ that contain 'setup_client'
rg -n 'def setup_client' examples/account/ --type py

# Also search for files that manually set up client with load_dotenv, Network, etc.
echo "=== Files with load_dotenv pattern ==="
rg -l 'load_dotenv\(\)' examples/account/ --type py

# List all Python files in examples/account/
echo "=== All Python files in examples/account/ ==="
fd -e py . examples/account/

Length of output: 2261

---

🏁 Script executed:

#!/bin/bash
# Check one of the files with setup_client to see the current pattern
echo "=== Example 1: account_allowance_approve_transaction_hbar.py ==="
cat examples/account/account_allowance_approve_transaction_hbar.py

echo -e "\n=== Reference: examples/client/client.py ==="
cat examples/client/client.py

echo -e "\n=== Reference: account_create_transaction_without_alias.py ==="
cat examples/account/account_create_transaction_without_alias.py

Length of output: 12627

---

🏁 Script executed:

#!/bin/bash
# Check a few more files to understand the pattern
echo "=== Checking account_update_transaction.py ==="
head -80 examples/account/account_update_transaction.py

echo -e "\n=== Checking account_create_transaction_with_fallback_alias.py ==="
head -80 examples/account/account_create_transaction_with_fallback_alias.py

echo -e "\n=== Checking if there are files without setup_client but with manual client setup ==="
rg -n 'Client\(Network' examples/account/ --type py | head -20

Length of output: 5370

---

🏁 Script executed:

#!/bin/bash
# Check files that might not have setup_client but have manual client setup
echo "=== Checking account_create_transaction.py ==="
cat examples/account/account_create_transaction.py

echo -e "\n=== Checking account_delete_transaction.py ==="
cat examples/account/account_delete_transaction.py

echo -e "\n=== Checking account_info.py ==="
cat examples/account/account_info.py

echo -e "\n=== Checking account_id.py ==="
cat examples/account/account_id.py

Length of output: 13012

---

🏁 Script executed:

#!/bin/bash
# Check the remaining files to understand their setup_client patterns
echo "=== account_create_transaction_evm_alias.py ==="
head -100 examples/account/account_create_transaction_evm_alias.py

echo -e "\n=== account_create_transaction_create_with_alias.py ==="
head -100 examples/account/account_create_transaction_create_with_alias.py

echo -e "\n=== account_records_query.py ==="
head -80 examples/account/account_records_query.py

Length of output: 8989

---

Task: Refactor setup_client() in examples/account to use Client.from_env()

Based on the issue requirements, I need to refactor 6 files in the examples/account/ directory that still use the old manual client setup pattern. The refactoring will:

1. Replace manual client initialization with Client.from_env()
2. Remove unnecessary imports (Network, dotenv-related if not used elsewhere)
3. Remove module-level load_dotenv() and network_name variables
4. Simplify the setup_client() function

Files to refactor:

• account_allowance_approve_transaction_hbar.py
• account_allowance_approve_transaction_nft.py
• account_allowance_delete_transaction_hbar.py
• account_allowance_delete_transaction_nft.py
• account_records_query.py
• account_update_transaction.py

Files already using Client.from_env() (no changes needed):

• account_create_transaction_without_alias.py ✓
• account_create_transaction_with_fallback_alias.py ✓
• account_create_transaction_evm_alias.py ✓
• account_create_transaction_create_with_alias.py ✓
• account_create_transaction.py ✓
• account_delete_transaction.py ✓

---

🏁 Script executed:

#!/bin/bash
# Read the file to understand its structure
cat examples/account/account_allowance_approve_transaction_nft.py | head -80

Length of output: 2449

---

🏁 Script executed:

#!/bin/bash
# Read the file to understand its structure
cat examples/account/account_allowance_delete_transaction_nft.py | head -80

Length of output: 2228

---

🏁 Script executed:

#!/bin/bash
# Check how setup_client() is called in the NFT files to understand the return signature usage
echo "=== Usage in account_allowance_approve_transaction_nft.py ==="
rg -A5 'setup_client\(\)' examples/account/account_allowance_approve_transaction_nft.py

echo -e "\n=== Usage in account_allowance_delete_transaction_nft.py ==="
rg -A5 'setup_client\(\)' examples/account/account_allowance_delete_transaction_nft.py

# Also check the full signature in both files
echo -e "\n=== Full setup_client in NFT approve ==="
sed -n '57,74p' examples/account/account_allowance_approve_transaction_nft.py

echo -e "\n=== Full setup_client in NFT delete ==="
sed -n '42,65p' examples/account/account_allowance_delete_transaction_nft.py

Length of output: 2833

---

🏁 Script executed:

#!/bin/bash
# Get the full view of how main() uses the setup_client in both NFT files
echo "=== Main function in account_allowance_approve_transaction_nft.py ==="
tail -50 examples/account/account_allowance_approve_transaction_nft.py

echo -e "\n=== Main function in account_allowance_delete_transaction_nft.py ==="
tail -50 examples/account/account_allowance_delete_transaction_nft.py

Length of output: 3471

---

@github-actions[bot], I've analyzed the issue and created a comprehensive plan to refactor all the setup_client() functions in the examples/account/ directory to use the new Client.from_env() method.

Summary

I've identified 6 files that need refactoring. Here's the breakdown:

Files to refactor:

1. ✅ account_allowance_approve_transaction_hbar.py
2. ✅ account_allowance_approve_transaction_nft.py (returns tuple)
3. ✅ account_allowance_delete_transaction_hbar.py
4. ✅ account_allowance_delete_transaction_nft.py (returns tuple)
5. ✅ account_records_query.py
6. ✅ account_update_transaction.py

Files already using Client.from_env() (no changes needed):

• account_create_transaction_without_alias.py ✓
• account_create_transaction_with_fallback_alias.py ✓
• account_create_transaction_evm_alias.py ✓
• account_create_transaction_create_with_alias.py ✓
• account_create_transaction.py ✓
• account_delete_transaction.py ✓

Note: The two NFT files have a different return signature - they return (client, operator_id, operator_key) tuple, which I've preserved in the plan.

Benefits of this refactoring:

• Reduces code duplication
• Removes 10+ lines per file
• Simplifies client setup
• Makes examples more maintainable
• Uses the new SDK convenience method

The plan includes detailed diffs for each file showing exactly what changes need to be made. Another agent will now take over to implement these changes.

---

💡 Use @coderabbitai plan to create a plan for code changes

[Pradeepbeleri]

/assign